لیست پیام های Gmail، لیست پیام های Gmail

این صفحه نحوه فراخوانی متد users.messages.list از API جیمیل را توضیح می‌دهد.

این متد آرایه‌ای از منابع Message Gmail را برمی‌گرداند که شامل id پیام و threadId است. برای بازیابی جزئیات کامل پیام، از متد users.messages.get استفاده کنید.

پیش‌نیازها

پایتون

یک پروژه گوگل کلود با Gmail API فعال. برای مراحل، راهنمای سریع Gmail API پایتون را تکمیل کنید.

لیست کردن پیام‌ها

متد users.messages.list از چندین پارامتر پرس‌وجو برای فیلتر کردن پیام‌ها پشتیبانی می‌کند:

  • maxResults : حداکثر تعداد پیام‌هایی که باید برگردانده شوند (پیش‌فرض ۱۰۰، حداکثر ۵۰۰).
  • pageToken : توکنی برای بازیابی یک صفحه خاص از نتایج.
  • q : رشته پرس‌وجو برای فیلتر کردن پیام‌ها، مانند from:someuser@example.com is:unread" .
  • labelIds : فقط پیام‌هایی را برمی‌گرداند که برچسب‌هایشان با تمام شناسه‌های برچسب مشخص‌شده مطابقت دارد.
  • includeSpamTrash : پیام‌های مربوط به SPAM و TRASH را در نتایج لحاظ می‌کند.

نمونه کد

پایتون

نمونه کد زیر نحوه فهرست کردن پیام‌ها برای کاربر احراز هویت شده Gmail را نشان می‌دهد. این کد، صفحه‌بندی را برای بازیابی تمام پیام‌های منطبق با پرس‌وجو مدیریت می‌کند.

gmail/snippet/list_messages.py
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()

متد users.messages.list یک بدنه پاسخ برمی‌گرداند که شامل موارد زیر است:

  • messages[] : آرایه‌ای از منابع Message .
  • nextPageToken : برای درخواست‌هایی با چندین صفحه نتیجه، توکنی که می‌تواند با فراخوانی‌های بعدی برای فهرست کردن پیام‌های بیشتر استفاده شود.
  • resultSizeEstimate : تعداد کل تخمینی نتایج.

برای دریافت محتوای کامل پیام و فراداده‌ها، از فیلد message.id برای فراخوانی متد users.messages.get استفاده کنید.