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

Các tham số
userId

string

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

Tham số truy vấn

Các tham số
maxResults

integer (uint32 format)

Số lượng luồng tối đa cần trả về. Theo mặc định, trường này 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 trang kết quả cụ thể trong danh sách.
q

string

Chỉ trả về các chuỗi khớp với truy vấn được chỉ định. Hỗ trợ định dạng truy vấn tương tự 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 được dùng thông số khi truy cập vào API bằng phạm vi gmail.metadata.
labelIds[]

string

Chỉ trả về các chuỗi có nhãn khớp với tất cả mã nhận dạng nhãn đã chỉ định.
includeSpamTrash

boolean

Đưa các chuỗi 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 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Các trường
threads[]

object (Thread)

Danh sách chuỗi thư. 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 nhất định bằng phương thức threads.get.
nextPageToken

string

Mã thông báo trang để truy xuất trang tiếp theo của kết quả 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.