Method: users.drafts.list

इससे उपयोगकर्ता के मेलबॉक्स में मौजूद ड्राफ़्ट की सूची मिलती है.

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

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

यह यूआरएल, 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".
includeSpamTrash

boolean

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

अनुरोध का मुख्य भाग

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

जवाब का मुख्य भाग

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

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

object (Draft)

ड्राफ़्ट की सूची. ध्यान दें कि हर Draft संसाधन में मौजूद 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.compose
  • https://www.googleapis.com/auth/gmail.readonly

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