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

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