Method: users.messages.list

Liệt kê các thư trong hộp thư của người dùng.

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. Giá trị đặc biệt me có thể dùng để cho biết người dùng đã được xác thực.

Tham số truy vấn

Tham số
maxResults

integer (uint32 format)

Số lượng tin nhắn tối đa cần trả về. Trường này được 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ông báo khớp với truy vấn đã chỉ định. Hỗ trợ cùng một định dạng truy vấn như hộp tìm kiếm của Gmail. Ví dụ: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Bạn không thể dùng thông số khi truy cập API bằng phạm vi gmail.metadata.
labelIds[]

string

Chỉ trả lại thư có nhãn khớp với tất cả ID nhãn được chỉ định. Thư trong một chuỗi có thể có nhãn mà các thư khác trong cùng một chuỗi không có. Để tìm hiểu thêm, hãy xem phần Quản lý nhãn trên thư và chuỗi thư.
includeSpamTrash

boolean

Bao gồm các tin nhắn từ SPAM và TRASH trong 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 tin nhắn. Lưu ý rằng mỗi tài nguyên thông báo chỉ chứa id và threadId. Bạn có thể tìm nạp thông tin chi tiết bổ sung về tin nhắn 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 uỷ quyền.