Method: users.threads.list

इससे, उपयोगकर्ता के मेलबॉक्स में मौजूद थ्रेड की सूची दिखती है. ज़्यादा जानकारी के लिए, थ्रेड मैनेज करना लेख पढ़ें.

एचटीटीपी अनुरोध

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
userId

string

उपयोगकर्ता का ईमेल पता. खास वैल्यू me का इस्तेमाल, पुष्टि किए गए उपयोगकर्ता की पहचान करने के लिए किया जा सकता है.

क्वेरी पैरामीटर

पैरामीटर
maxResults

integer (uint32 format)

ज़्यादा से ज़्यादा कितने थ्रेड लौटाने हैं. इस फ़ील्ड की डिफ़ॉल्ट वैल्यू 100 होती है. इस फ़ील्ड के लिए, ज़्यादा से ज़्यादा 500 वैल्यू सेट की जा सकती है.

pageToken

string

सूची में नतीजों का कोई खास पेज पाने के लिए, पेज टोकन.

q

string

सिर्फ़ तय की गई क्वेरी से मेल खाने वाले थ्रेड लौटाएं. यह Gmail के खोज बॉक्स के जैसे ही क्वेरी फ़ॉर्मैट के साथ काम करता है. उदाहरण के लिए, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". gmail.metadata स्कोप का इस्तेमाल करके एपीआई को ऐक्सेस करने पर, इस पैरामीटर का इस्तेमाल नहीं किया जा सकता.

labelIds[]

string

सिर्फ़ उन थ्रेड को लौटाएं जिनमें ऐसे लेबल हों जो तय किए गए सभी लेबल आईडी से मेल खाते हों.

includeSpamTrash

boolean

नतीजों में SPAM और TRASH फ़ोल्डर के थ्रेड शामिल करें.

अनुरोध का मुख्य हिस्सा

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य हिस्सा

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है:

JSON फ़ॉर्मैट में दिखाया गया है
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
फ़ील्ड
threads[]

object (Thread)

थ्रेड की सूची. ध्यान दें कि हर थ्रेड रिसॉर्स में messages की सूची शामिल नहीं होती. किसी थ्रेड के लिए messages की सूची, threads.get तरीके का इस्तेमाल करके फ़ेच की जा सकती है.

nextPageToken

string

सूची में नतीजों का अगला पेज पाने के लिए, पेज टोकन.

resultSizeEstimate

integer (uint32 format)

नतीजों की अनुमानित कुल संख्या.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

ज़्यादा जानकारी के लिए, अनुमति देने की गाइड देखें.