Method: users.messages.list

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

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

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

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.