Method: users.messages.list

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

HTTP-запрос

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

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

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

Параметры
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

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

,

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

HTTP-запрос

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

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

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

Параметры
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

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