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"입니다. gmail.metadata 범위를 사용하여 API에 액세스할 때는 매개변수를 사용할 수 없습니다.
labelIds[]

string

지정된 모든 라벨 ID와 일치하는 라벨이 있는 메일만 반환합니다. 대화목록의 메일에는 라벨이 있지만 동일한 대화목록의 다른 메일에는 없는 라벨이 있을 수 있습니다. 자세한 내용은 메일 및 대화목록의 라벨 관리하기를 참고하세요.
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

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