Method: users.messages.list

Liệt kê các thư trong hộp thư của người dùng. Để biết thêm thông tin, hãy xem bài viết Liệt kê thư trong Gmail.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
userId

string

Địa chỉ email của người dùng. Bạn có thể dùng giá trị đặc biệt me để cho biết người dùng đã xác thực.

Tham số truy vấn

Tham số
maxResults

integer (uint32 format)

Số lượng thư tối đa cần trả về. Trường này mặc định là 100. Giá trị tối đa được phép cho trường này là 500.
pageToken

string

Mã thông báo trang để truy xuất một trang kết quả cụ thể trong danh sách.
q

string

Chỉ trả về những thư khớp với truy vấn đã chỉ định. Hỗ trợ cùng định dạng truy vấn như hộp tìm kiếm trong Gmail. Ví dụ: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Không thể sử dụng tham số khi truy cập vào API bằng phạm vi gmail.metadata.
labelIds[]

string

Chỉ trả về những thư có nhãn khớp với tất cả mã nhận dạng nhãn đã chỉ định. Các thư trong một chuỗi có thể có nhãn mà các thư khác trong cùng chuỗi không có. Để tìm hiểu thêm, hãy xem bài viết Quản lý nhãn trên thư và chuỗi.
includeSpamTrash

boolean

Đưa thư từ SPAM và TRASH vào kết quả.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Trường
messages[]

object (Message)

Danh sách thư. Xin lưu ý rằng mỗi tài nguyên thư chỉ chứa một id và một threadId. Bạn có thể tìm nạp thông tin chi tiết bổ sung về thư bằng phương thức messages.get.
nextPageToken

string

Mã thông báo để truy xuất trang kết quả tiếp theo trong danh sách.
resultSizeEstimate

integer (uint32 format)

Tổng số kết quả ước tính.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Để biết thêm thông tin, hãy xem hướng dẫn về Uỷ quyền.