Method: users.drafts.list

Liệt kê các thư nháp trong hộp thư của người dùng. Để biết thêm thông tin, hãy xem bài viết Tạo và gửi email nháp.

Yêu cầu HTTP

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

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ể 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

Tham số
maxResults

integer (uint32 format)

Số lượng thư nháp 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ề các thư nháp 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".
includeSpamTrash

boolean

Bao gồm thư nháp 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 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Trường
drafts[]

object (Draft)

Danh sách thư nháp. Xin lưu ý rằng thuộc tính Message trong mỗi tài nguyên Draft chỉ chứa id và threadId. Phương thức messages.get có thể tìm nạp thêm thông tin chi tiết về thư.
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.compose
  • https://www.googleapis.com/auth/gmail.readonly

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