Method: users.messages.list

Перечисляет сообщения в почтовом ящике пользователя.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
userId

string

Адрес электронной почты пользователя. Специальное значение me можно использовать для указания аутентифицированного пользователя.

Параметры запроса

Параметры
maxResults

integer ( uint32 format)

Максимальное количество возвращаемых сообщений. По умолчанию это поле равно 100. Максимально допустимое значение для этого поля — 500.

pageToken

string

Токен страницы для получения определенной страницы результатов в списке.

q

string

Возвращайте только сообщения, соответствующие указанному запросу. Поддерживает тот же формат запроса, что и поле поиска Gmail. Например, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" . Параметр нельзя использовать при доступе к API с использованием области gmail.metadata.

labelIds[]

string

Возвращайте сообщения только с метками, которые соответствуют всем указанным идентификаторам меток. Сообщения в цепочке могут иметь метки, которых нет у других сообщений в той же цепочке. Дополнительные сведения см. в разделе Управление метками сообщений и цепочек .

includeSpamTrash

boolean

Включать в результаты сообщения из SPAM и TRASH .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Поля
messages[]

object ( Message )

Список сообщений. Обратите внимание, что каждый ресурс сообщения содержит только id и threadId . Дополнительные сведения о сообщении можно получить с помощью метода messages.get .

nextPageToken

string

Токен для получения следующей страницы результатов в списке.

resultSizeEstimate

integer ( uint32 format)

Примерное общее количество результатов.

Области авторизации

Требуется одна из следующих областей 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

Дополнительную информацию см. в руководстве по авторизации .