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

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