Gmail API

API Gmail cho phép bạn xem và quản lý dữ liệu hộp thư của Gmail như chuỗi, thư và nhãn.

Dịch vụ: gmail.googleapis.com

Để gọi dịch vụ này, bạn nên sử dụng thư viện ứng dụng do Google cung cấp. Nếu ứng dụng của bạn cần sử dụng thư viện của riêng bạn để gọi dịch vụ này, hãy sử dụng thông tin sau đây khi đưa ra yêu cầu API.

Tài liệu khám phá

Tài liệu khám phá là một thông số kỹ thuật mà máy đọc được để mô tả và sử dụng các API REST. API này được dùng để xây dựng thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác tương tác với các API của Google. Một dịch vụ có thể cung cấp nhiều tài liệu khám phá. Dịch vụ này cung cấp tài liệu khám phá sau đây:

Điểm cuối dịch vụ

Điểm cuối dịch vụ là một URL cơ sở chỉ định địa chỉ mạng của dịch vụ API. Một dịch vụ có thể có nhiều điểm cuối dịch vụ. Dịch vụ này có điểm cuối của dịch vụ sau đây và tất cả các URI bên dưới đều liên quan đến điểm cuối của dịch vụ này:

  • https://gmail.googleapis.com

Tài nguyên REST: v1.users

Phương thức
getProfile GET /gmail/v1/users/{userId}/profile
Lấy hồ sơ Gmail của người dùng hiện tại.
stop POST /gmail/v1/users/{userId}/stop
Ngừng nhận thông báo đẩy đối với hộp thư cụ thể của người dùng.
watch POST /gmail/v1/users/{userId}/watch
Thiết lập hoặc cập nhật đồng hồ thông báo đẩy trên hộp thư của người dùng cụ thể.

Tài nguyên REST: v1.users.drafts

Phương thức
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Tạo bản nháp mới có nhãn DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Xoá ngay lập tức và vĩnh viễn bản nháp đã chỉ định.
get GET /gmail/v1/users/{userId}/drafts/{id}
Lấy bản nháp được chỉ định.
list GET /gmail/v1/users/{userId}/drafts
Liệt kê thư nháp trong hộp thư của người dùng.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Gửi thư nháp hiện có đã được chỉ định đến người nhận trong các tiêu đề To, Cc và Bcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Thay thế nội dung của bản nháp.

Tài nguyên REST: v1.users.history

Phương thức
list GET /gmail/v1/users/{userId}/history
Liệt kê toàn bộ thay đổi đối với hộp thư cụ thể.

Tài nguyên REST: v1.users.labels

Phương thức
create POST /gmail/v1/users/{userId}/labels
Tạo nhãn mới.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Xoá ngay lập tức và vĩnh viễn nhãn đã chỉ định, đồng thời xoá nhãn đó khỏi mọi thư và chuỗi được áp dụng.
get GET /gmail/v1/users/{userId}/labels/{id}
Lấy nhãn đã chỉ định.
list GET /gmail/v1/users/{userId}/labels
Liệt kê tất cả các nhãn trong hộp thư của người dùng.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Dán nhãn đã chỉ định.
update PUT /gmail/v1/users/{userId}/labels/{id}
Cập nhật nhãn đã chỉ định.

Tài nguyên REST: v1.users.messages

Phương thức
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Xoá nhiều thư theo mã nhận dạng thư.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Sửa đổi nhãn trên các thư được chỉ định.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Xoá ngay lập tức và vĩnh viễn tin nhắn được chỉ định.
get GET /gmail/v1/users/{userId}/messages/{id}
Nhận thông báo được chỉ định.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Chỉ nhập thư vào hộp thư của người dùng này, với tính năng quét gửi và phân loại email tiêu chuẩn tương tự như nhận qua SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Chèn trực tiếp thư vào chỉ hộp thư của người dùng này, tương tự như IMAP APPEND, bỏ qua hầu hết các quá trình quét và phân loại.
list GET /gmail/v1/users/{userId}/messages
Liệt kê các thư trong hộp thư của người dùng.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Sửa đổi các nhãn trên thông báo được chỉ định.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Gửi thư được chỉ định đến người nhận trong tiêu đề To, Cc và Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Chuyển thư được chỉ định vào thùng rác.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Xoá thư được chỉ định khỏi thùng rác.

Tài nguyên REST: v1.users.messages.attachments

Phương thức
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Nhận tin nhắn đính kèm được chỉ định.

Tài nguyên REST: v1.users.settings

Phương thức
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Nhận chế độ cài đặt tự động chuyển tiếp cho tài khoản đã chỉ định.
getImap GET /gmail/v1/users/{userId}/settings/imap
Tải chế độ cài đặt IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Tải chế độ cài đặt ngôn ngữ.
getPop GET /gmail/v1/users/{userId}/settings/pop
Tải chế độ cài đặt POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Tải chế độ cài đặt tính năng tự động trả lời thư.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Cập nhật chế độ cài đặt tự động chuyển tiếp cho tài khoản được chỉ định.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Cập nhật chế độ cài đặt IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Cập nhật chế độ cài đặt ngôn ngữ.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Cập nhật các chế độ cài đặt POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Cập nhật chế độ cài đặt của tính năng tự động trả lời thư.

Tài nguyên REST: v1.users.settings.cse.identities

Phương thức
create POST /gmail/v1/users/{userId}/settings/cse/identities
Tạo và định cấu hình thông tin nhận dạng được mã hoá phía máy khách được phép gửi thư từ tài khoản người dùng.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Xoá thông tin nhận dạng được mã hoá phía máy khách.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Truy xuất cấu hình thông tin nhận dạng mã hoá phía máy khách.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Liệt kê các danh tính được mã hoá phía máy khách của người dùng đã xác thực.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Liên kết một cặp khoá khác với thông tin nhận dạng hiện có trong tính năng mã hoá phía máy khách.

Tài nguyên REST: v1.users.settings.cse.keypairs

Phương thức
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Tạo và tải chuỗi chứng chỉ khoá công khai S/MIME được mã hoá phía máy khách lên và siêu dữ liệu khoá riêng tư cho người dùng đã xác thực.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Tắt cặp khoá mã hoá phía máy khách.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Bật cặp khoá mã hoá phía máy khách đã bị tắt.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Truy xuất cặp khoá mã hoá phía máy khách hiện có.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Liệt kê các cặp khoá mã hoá phía máy khách của người dùng đã xác thực.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Xoá vĩnh viễn và ngay lập tức cặp khoá mã hoá phía máy khách.

Tài nguyên REST: v1.users.settings.delegates

Phương thức
create POST /gmail/v1/users/{userId}/settings/delegates
Thêm người được uỷ quyền có trạng thái xác minh được đặt trực tiếp thành accepted mà không cần gửi bất kỳ email xác minh nào.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Xoá người được uỷ quyền đã chỉ định (có thể ở trạng thái xác minh bất kỳ) và thu hồi mọi quy trình xác minh có thể cần thiết để sử dụng đối tượng đó.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Lấy đối tượng được uỷ quyền đã chỉ định.
list GET /gmail/v1/users/{userId}/settings/delegates
Liệt kê những người được uỷ quyền cho tài khoản đã chỉ định.

Tài nguyên REST: v1.users.settings.filters

Phương thức
create POST /gmail/v1/users/{userId}/settings/filters
Tạo bộ lọc.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Xoá ngay lập tức và vĩnh viễn bộ lọc đã chỉ định.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Lấy bộ lọc.
list GET /gmail/v1/users/{userId}/settings/filters
Liệt kê các bộ lọc thư của người dùng Gmail.

Tài nguyên REST: v1.users.settings.forwardingAddresses

Phương thức
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Tạo địa chỉ chuyển tiếp.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Xoá địa chỉ chuyển tiếp đã chỉ định và thu hồi mọi quy trình xác minh có thể được yêu cầu.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Lấy địa chỉ chuyển tiếp được chỉ định.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Liệt kê các địa chỉ chuyển tiếp cho tài khoản đã chỉ định.

Tài nguyên REST: v1.users.settings.sendAs

Phương thức
create POST /gmail/v1/users/{userId}/settings/sendAs
Tạo email đại diện tuỳ chỉnh "from" (gửi).
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Xoá các bí danh được chỉ định gửi bằng địa chỉ.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Nhận bí danh được chỉ định gửi bằng địa chỉ.
list GET /gmail/v1/users/{userId}/settings/sendAs
Liệt kê các email đại diện gửi bằng địa chỉ cho tài khoản đã chỉ định.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
vá các bí danh gửi dưới dạng được chỉ định.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Cập nhật email đại diện gửi bằng địa chỉ.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Gửi email xác minh đến địa chỉ email đại diện đã chỉ định.

Tài nguyên REST: v1.users.settings.sendAs.smimeInfo

Phương thức
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Xoá cấu hình S/MIME đã chỉ định cho bí danh gửi bằng địa chỉ đã chỉ định.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Lấy cấu hình S/MIME đã chỉ định cho bí danh gửi bằng địa chỉ đã chỉ định.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Chèn (tải lên) cấu hình S/MIME đã chỉ định cho email đại diện gửi bằng địa chỉ đã chỉ định.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Liệt kê các cấu hình S/MIME cho bí danh được chỉ định để gửi bằng địa chỉ.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Đặt cấu hình S/MIME mặc định cho bí danh gửi bằng địa chỉ đã chỉ định.

Tài nguyên REST: v1.users.threads

Phương thức
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Xoá ngay lập tức và vĩnh viễn chuỗi đã chỉ định.
get GET /gmail/v1/users/{userId}/threads/{id}
Lấy luồng đã chỉ định.
list GET /gmail/v1/users/{userId}/threads
Liệt kê các chuỗi trong hộp thư của người dùng.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Sửa đổi các nhãn được áp dụng cho chuỗi.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Chuyển chuỗi đã chỉ định vào thùng rác.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Xoá chuỗi đã chỉ định khỏi thùng rác.