Gmail API

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

Dịch vụ: gmail.googleapis.com

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

Tài liệu khám phá

Tài liệu khám phá là một quy cách có thể đọc được bằng máy để mô tả và sử dụng API REST. Quy cách này được dùng để tạo các thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác có tương tác với 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:

Đ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 một 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 dịch vụ sau và tất cả URI bên dưới đều liên quan đến điểm cuối 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
Tắt tính năng gửi thông báo đẩy cho hộp thư của người dùng đã cho.
watch POST /gmail/v1/users/{userId}/watch
Thiết lập hoặc cập nhật chế độ theo dõi thông báo đẩy trên hộp thư của người dùng đã cho.

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 thư nháp 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 được 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ê các 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 bản nháp hiện có đã chỉ định cho người nhận trong 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ê nhật ký của tất cả các thay đổi đối với hộp thư đã cho.

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

Phương thức
create POST /gmail/v1/users/{userId}/labels
Tạo nhãn.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Xoá ngay lập tức và vĩnh viễn nhãn được chỉ định, đồng thời xoá nhãn đó khỏi mọi thư và chuỗi thư mà nhãn đó được áp dụng.
get GET /gmail/v1/users/{userId}/labels/{id}
Nhận nhãn đã chỉ định.
list GET /gmail/v1/users/{userId}/labels
Liệt kê tất cả nhãn trong hộp thư của người dùng.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Vá nhãn được chỉ định.
update PUT /gmail/v1/users/{userId}/labels/{id}
Cập nhật nhãn được 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ã 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 thư được chỉ định.
get GET /gmail/v1/users/{userId}/messages/{id}
Nhận thông báo đã chỉ định.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Nhập một thư chỉ vào hộp thư của người dùng này, với tính năng quét và phân loại thư tiêu chuẩn tương tự như khi nhận qua SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Chỉ chèn trực tiếp một thư vào 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 quy 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 nhãn trên thư được chỉ định.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Gửi thư đã chỉ định đến người nhận trong tiêu đề To, Cc và Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Di chuyển thư đã chỉ định vào thùng rác.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Xoá thư 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 tệp đính kèm thư được chỉ định.

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

Phương thức
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Lấy 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
Lấy chế độ cài đặt IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Lấy chế độ cài đặt ngôn ngữ.
getPop GET /gmail/v1/users/{userId}/settings/pop
Lấy chế độ cài đặt POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Lấy chế độ cài đặt thư trả lời tự động.
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 chế độ cài đặt POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Cập nhật chế độ cài đặt thư trả lời tự động khi đi vắng.

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 một danh tính tính năng 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á một danh tính 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 danh tính tính nă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 một 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 danh tính tính năng mã hoá phía máy khách hiện có.

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 mã hoá phía máy khách 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 một cặp khoá tính năng mã hoá phía máy khách.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Bật mộ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 mộ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á tính năng mã hoá phía máy khách cho một 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 một cặp khoá của tính năng 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 một 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 gửi email xác minh nào.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Xoá người uỷ quyền được chỉ định (có thể có 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 yêu cầu để sử dụng người uỷ quyền đó.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Lấy đại biểu được chỉ định.
list GET /gmail/v1/users/{userId}/settings/delegates
Liệt kê 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}
Nhận một 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 đã 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 được 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 bí danh "từ" tuỳ chỉnh để gửi dưới tên khác.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Xoá bí danh gửi dưới tên người khác đã chỉ định.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Lấy email đại diện gửi dưới tên đã chỉ định.
list GET /gmail/v1/users/{userId}/settings/sendAs
Liệt kê các bí danh gửi dưới tên cho tài khoản được chỉ định.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Sửa đổi bí danh gửi dưới tên đã chỉ định.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Cập nhật một email đại diện để gửi thư.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Gửi email xác minh đến địa chỉ email đại diện gửi dưới tên mình đã 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 dưới tên đã 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 dưới tên đã chỉ định.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Chèn (tải lên) cấu hình S/MIME đã cho cho bí danh gửi dưới tên đã chỉ định.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Liệt kê các cấu hình S/MIME cho email đại diện gửi dưới tên đã chỉ định.
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 dưới tên đã chỉ định.

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

Phương thức
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Xoá vĩnh viễn và ngay lập tức chuỗi tin nhắn đã 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 nhãn được áp dụng cho luồng.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Di chuyển chuỗi tin nhắn đã 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.