- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- Hãy làm thử!
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
Các tham số | |
---|---|
userId |
Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt |
Tham số truy vấn
Các tham số | |
---|---|
maxResults |
Số lượng thư 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 |
Mã thông báo trang để truy xuất trang kết quả cụ thể trong danh sách. |
q |
Chỉ trả về những thông điệp 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ụ: |
labelIds[] |
Chỉ trả về những thư có nhãn khớp với tất cả các mã nhãn đã chỉ định. Thư trong một chuỗi có thể có nhãn mà các thư khác trong cùng chuỗi không có. Để tìm hiểu thêm, hãy xem bài viết Quản lý nhãn trên thư và chuỗi thư. |
includeSpamTrash |
Bao gồm tin nhắn từ |
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 ( |
Các trường | |
---|---|
messages[] |
Danh sách tin nhắn. Xin lưu ý rằng mỗi tài nguyên thông báo chỉ chứa một |
nextPageToken |
Mã thông báo để truy xuất trang tiếp theo của kết quả trong danh sách. |
resultSizeEstimate |
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.