Method: users.threads.list

Wyświetla listę wątków w skrzynce pocztowej użytkownika.

Żądanie HTTP

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

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 wątków 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 wątki pasujące do określonego 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 wątki z etykietami, które pasują do wszystkich określonych identyfikatorów etykiet.

includeSpamTrash

boolean

Uwzględnij w wynikach wątki z domeny 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
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Pola
threads[]

object (Thread)

Lista wątków. Pamiętaj, że każdy zasób wątku nie zawiera listy messages. Listę messages dla danego wątku można pobrać przy użyciu metody threads.get.

nextPageToken

string

Token strony, aby pobrać następną stronę 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.