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

결과에 SPAMTRASH의 초안을 포함합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
필드
drafts[]

object (Draft)

초안 목록입니다. 각 Draft 리소스의 Message 속성에는 idthreadId만 포함됩니다. 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

자세한 내용은 승인 가이드를 참고하세요.