Method: users.messages.list

Wyświetla listę wiadomości w skrzynce pocztowej użytkownika.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Adres e-mail użytkownika. Specjalna wartość me może służyć do wskazania uwierzytelnionego użytkownika.

Parametry zapytania

Parametry
maxResults

integer (uint32 format)

Maksymalna liczba wiadomości do zwrócenia. Domyślna wartość w tym polu to 100. Maksymalna dozwolona wartość w tym polu to 500.
pageToken

string

Token strony do pobrania określonej strony z wynikami na liście.
q

string

Zwracaj tylko wiadomości pasujące do podanego zapytania. Obsługuje ten sam format zapytań co pole wyszukiwania Gmaila. Na przykład: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parametru nie można używać podczas uzyskiwania dostępu do interfejsu API za pomocą zakresu gmail.metadata.
labelIds[]

string

Zwracaj tylko wiadomości z etykietami, które pasują do podanych identyfikatorów etykiet. Wiadomości w wątku mogą mieć etykiety, których nie mają inne wiadomości w tym samym wątku. Więcej informacji znajdziesz w artykule Zarządzanie etykietami wiadomości i wątków.
includeSpamTrash

boolean

Uwzględnij w wynikach wiadomości od: SPAM i TRASH.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Pola
messages[]

object (Message)

Lista wiadomości. Pamiętaj, że każdy zasób wiadomości zawiera tylko id i threadId. Dodatkowe szczegóły wiadomości można pobrać przy użyciu metody messages.get.
nextPageToken

string

Token do pobierania następnej strony wyników na liście.
resultSizeEstimate

integer (uint32 format)

Szacunkowa łączna liczba wyników.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.