Method: users.threads.list

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

Yêu cầu HTTP

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

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

Tham số đường dẫn

Thông 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

Thông số
maxResults

integer (uint32 format)

Số lượng chuỗi 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 chuỗi 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 của Gmail. Ví dụ: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Không thể 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 chuỗi có nhãn khớp với tất cả mã nhận dạng nhãn được chỉ định.
includeSpamTrash

boolean

Bao gồm các chuỗi 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 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Trường
threads[]

object (Thread)

Danh sách các chuỗi tin nhắn. Xin lưu ý rằng mỗi tài nguyên luồng không chứa danh sách messages. Bạn có thể tìm nạp danh sách messages cho một luồng xử lý nhất định bằng phương thức threads.get.
nextPageToken

string

Mã thông báo trang để 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 OAuth 2.0 Overview.