Method: users.messages.list

Выводит список сообщений в почтовом ящике пользователя. Пример использования см. в разделе «Список сообщений Gmail» .

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

Для получения более подробной информации см.OAuth 2.0 Overview .