- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- इसे आज़माएं!
उपयोगकर्ता के मेलबॉक्स में मौजूद मैसेज की सूची बनाता है.
एचटीटीपी अनुरोध
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
userId |
उपयोगकर्ता का ईमेल पता. खास वैल्यू |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
maxResults |
लौटाए जाने वाले मैसेज की ज़्यादा से ज़्यादा संख्या. यह फ़ील्ड डिफ़ॉल्ट तौर पर 100 होता है. इस फ़ील्ड में ज़्यादा से ज़्यादा 500 वैल्यू डाली जा सकती हैं. |
pageToken |
पेज टोकन का इस्तेमाल कर सकता है. |
q |
सिर्फ़ दी गई क्वेरी से मेल खाने वाले मैसेज दिखाएं. Gmail के खोज बॉक्स वाले क्वेरी फ़ॉर्मैट के साथ काम करता है. उदाहरण के लिए, |
labelIds[] |
सिर्फ़ उन लेबल वाले मैसेज दिखाएं जो दिए गए सभी लेबल आईडी से मेल खाते हैं. किसी थ्रेड के मैसेज में ऐसे लेबल हो सकते हैं जो उसी थ्रेड के दूसरे मैसेज में नहीं हों. ज़्यादा जानने के लिए, मैसेज और थ्रेड पर लेबल मैनेज करना देखें. |
includeSpamTrash |
नतीजों में, |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"messages": [
{
object ( |
फ़ील्ड | |
---|---|
messages[] |
मैसेज की सूची. ध्यान दें कि हर मैसेज रिसॉर्स में सिर्फ़ एक |
nextPageToken |
सूची में मौजूद नतीजों का अगला पेज दिखाने के लिए टोकन. |
resultSizeEstimate |
नतीजों की कुल अनुमानित संख्या. |
अनुमति देने के दायरे
इनमें से कोई एक 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
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.