Method: users.messages.list

उपयोगकर्ताओं के मेलबॉक्स में मैसेज की सूची बनाता है.

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

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

यह यूआरएल 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 के काेड में दिखाना 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
फ़ील्ड
messages[]

object (Message)

मैसेज की सूची. ध्यान दें कि हर मैसेज संसाधन में सिर्फ़ एक id और एक threadId होता है. messages.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

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