Method: users.threads.list

Liệt kê các chuỗi 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}/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ể sử dụng giá trị đặc biệt me để cho biết người dùng đã được xác thực.

Tham số truy vấn

Thông số
maxResults

integer (uint32 format)

Số lượng luồng tối đa cần trả về. Trường này có giá trị 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ề các luồng khớp với truy vấn đã chỉ định. Hỗ trợ định dạng truy vấn giống 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ể sử dụng thông số này khi truy cập vào API bằng phạm vi gmail.metadata.
labelIds[]

string

Chỉ trả về các luồng có nhãn khớp với tất cả mã nhãn được chỉ định.
includeSpamTrash

boolean

Thêm các luồng 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
}
Trường
threads[]

object (Thread)

Danh sách luồng. 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 nhất định bằng cách sử dụ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 Hướng dẫn uỷ quyền.