Method: users.drafts.list

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

HTTP-запрос

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

В 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" .

includeSpamTrash

boolean

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

Текст запроса

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

Ответный текст

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

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

object ( Draft )

Список черновиков. Обратите внимание, что свойство Message в каждом ресурсе Draft содержит только 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.compose
  • https://www.googleapis.com/auth/gmail.readonly

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