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

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