Gmail मैसेज की सूची

इस दस्तावेज़ में, Gmail API के messages.list तरीके को कॉल करने का तरीका बताया गया है.

यह तरीका, Gmail messages ऑब्जेक्ट का कलेक्शन दिखाता है. इसमें मैसेज id और threadId शामिल होते हैं. मैसेज की पूरी जानकारी पाने के लिए, messages.get तरीके का इस्तेमाल करें.

जवाब में मिले messages ऑब्जेक्ट, समय के हिसाब से उलटे क्रम में (सबसे नया ऑब्जेक्ट सबसे पहले) दिखाए जाते हैं.

ज़रूरी शर्तें

Python

Gmail API की सुविधा वाला Google Cloud प्रोजेक्ट. इसके लिए, Gmail API Python की क्विकस्टार्ट गाइड में दिया गया तरीका अपनाएं.

मैसेज की सूची बनाना

messages.list तरीके में, मैसेज फ़िल्टर करने के लिए कई क्वेरी पैरामीटर इस्तेमाल किए जा सकते हैं:

• maxResults: जवाब के तौर पर ज़्यादा से ज़्यादा कितने मैसेज दिखाने हैं. डिफ़ॉल्ट रूप से, यह संख्या 100 होती है. हालांकि, इसे ज़्यादा से ज़्यादा 500 तक सेट किया जा सकता है.
• pageToken: नतीजों के किसी पेज को वापस पाने का टोकन.
• q: मैसेज फ़िल्टर करने के लिए क्वेरी स्ट्रिंग, जैसे कि from:[e-mail] is:unread.
• labelIds: सिर्फ़ उन मैसेज को वापस लाएं जिनके लेबल, बताए गए सभी लेबल आईडी से मेल खाते हों.
• includeSpamTrash: नतीजों में SPAM और TRASH से मिले मैसेज शामिल किए गए हैं.

कोड सैंपल

Python

नीचे दिए गए कोड सैंपल में, पुष्टि किए गए Gmail उपयोगकर्ता के लिए मैसेज की सूची बनाने का तरीका दिखाया गया है. यह कोड, क्वेरी से मेल खाने वाले सभी मैसेज पाने के लिए पेज नंबरिंग को मैनेज करता है.

gmail/snippet/list_messages.py

GitHub पर देखें

import os.path
from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# If modifying these scopes, delete the file token.json.
SCOPES = ["https://www.googleapis.com/auth/gmail.readonly"]


def main():
    """Shows basic usage of the Gmail API.
    Lists the user's Gmail messages.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists("token.json"):
        creds = Credentials.from_authorized_user_file("token.json", SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file("credentials.json", SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open("token.json", "w") as token:
            token.write(creds.to_json())

    try:
        # Call the Gmail API
        service = build("gmail", "v1", credentials=creds)
        results = (
            service.users().messages().list(userId="me", labelIds=["INBOX"]).execute()
        )
        messages = results.get("messages", [])

        if not messages:
            print("No messages found.")
            return

        print("Messages:")
        for message in messages:
            print(f'Message ID: {message["id"]}')
            msg = (
                service.users().messages().get(userId="me", id=message["id"]).execute()
            )
            print(f'  Subject: {msg["snippet"]}')

    except HttpError as error:
        # TODO(developer) - Handle errors from gmail API.
        print(f"An error occurred: {error}")


if __name__ == "__main__":
    main()

messages.list तरीके से मिलने वाले जवाब के मुख्य हिस्से में यह जानकारी शामिल होती है:

• messages[]: यह Message संसाधनों का कलेक्शन होता है.
• nextPageToken: यह टोकन, नतीजों के कई पेजों वाले अनुरोधों के लिए होता है. इसका इस्तेमाल, ज़्यादा मैसेज दिखाने के लिए बाद में किए जाने वाले कॉल के साथ किया जा सकता है.
• resultSizeEstimate: नतीजों की कुल अनुमानित संख्या.

पूरे मैसेज का कॉन्टेंट और मेटाडेटा फ़ेच करने के लिए, message.id फ़ील्ड का इस्तेमाल करके messages.get तरीके को कॉल करें.

मिलते-जुलते विषय

• मैसेज खोजना और फ़िल्टर करना