Di chuyển từ Email Settings API

Tài liệu này có thể giúp di chuyển ứng dụng của bạn từ Email Settings API đã ngừng hoạt động sang Gmail API.

Cấp phép cho yêu cầu

Giống như Email Settings API, Gmail API sử dụng giao thức OAuth 2.0 để cấp phép cho các yêu cầu. Một điểm khác biệt chính là quyền của Gmail API được giới hạn ở một người dùng riêng lẻ, thay vì toàn bộ miền. Điều này có nghĩa là việc cấp phép cho tài khoản quản trị viên miền không cho phép bạn di chuyển thư cho những người dùng khác trong miền. Thay vào đó, bạn phải sử dụng tài khoản dịch vụ tiêu chuẩn có quyền trên toàn miền được thêm vào danh sách cho phép trong Bảng điều khiển dành cho quản trị viên của Google để tạo mã thông báo xác thực thích hợp.

Email Settings API đã sử dụng phạm vi:

https://apps-apis.google.com/a/feeds/emailsettings/2.0/

Các phạm vi tương đương trong Gmail API là:

https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing

Thay đổi giao thức

Email Settings API sử dụng giao thức GDATA dựa trên XML. Gmail API sử dụng JSON. Vì chế độ cài đặt chủ yếu bao gồm các cặp khoá-giá trị, nên tải trọng về mặt khái niệm tương tự giữa các phiên bản.

Ví dụ về cách tạo nhãn:

Email Settings API

POST https://apps-apis.google.com/a/feeds/emailsettings/2.0/{domain name}/{username}/label
<?xml version="1.0" encoding="utf-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
  <apps:property name="label" value="status updates" />
</atom:entry>

Gmail API

POST https://www.googleapis.com/gmail/v1/users/{username}/labels
{
   "name": "status updates"
}

Hãy sử dụng thư viện ứng dụng được cung cấp thay vì trực tiếp triển khai giao thức.

Quản lý nhãn

Để quản lý nhãn trong Gmail API, hãy sử dụng tài nguyên labels.

Chế độ cài đặt cũ Chế độ cài đặt mới Ghi chú
labelId id
nhãn tên
unreadCount messagesUnread
mức hiển thị labelListVisibility SHOW hiện là labelShow
HIDE hiện là labelHide

Thay đổi khác

  • Khi cập nhật hoặc xoá nhãn, Gmail API tham chiếu đến nhãn theo mã thay vì theo tên.

Quản lý bộ lọc

Để quản lý bộ lọc trong Gmail API, hãy sử dụng tài nguyên settings.filters.

Chế độ cài đặt cũ Chế độ cài đặt mới Ghi chú
từ criteria.from
tới criteria.to
chủ đề criteria.subject
hasTheWord criteria.query
doesNotHaveTheWord criteria.negatedQuery
hasAttachment criteria.hasAttachment
shouldArchive action.removeLabelIds Sử dụng INBOX làm mã nhãn
shouldMarkAsRead action.removeLabelIds Sử dụng UNREAD làm mã nhãn
shouldStar action.addLabelIds Sử dụng STARRED làm mã nhãn
nhãn action.addLabelIds Sử dụng mã của nhãn để thêm
forwardTo action.forward
shouldTrash action.addLabelIds Sử dụng TRASH làm mã nhãn
neverSpam action.removeLabelIds Sử dụng SPAM làm mã nhãn

Thay đổi khác

  • Nếu bạn thêm nhãn người dùng chưa tồn tại, thì bạn phải tạo nhãn đó một cách rõ ràng bằng phương thức labels.create.

Quản lý bí danh gửi dưới dạng

Để quản lý bí danh gửi dưới dạng trong Gmail API, hãy sử dụng tài nguyên settings.sendAs.

Chế độ cài đặt cũ Chế độ cài đặt mới
tên displayName
xử lý sendAsEmail
replyTo replyToAddress
makeDefault isDefault

Quản lý đoạn video trên web

Bạn không thể sử dụng chế độ cài đặt Đoạn video trên web trong Gmail API.

Quản lý tính năng tự động chuyển tiếp

Để quản lý tính năng tự động chuyển tiếp trong Gmail API, hãy sử dụng tài nguyên settings.

Chế độ cài đặt cũ Chế độ cài đặt mới Ghi chú
bật đang bật
forwardTo emailAddress
hành động disposition KEEP hiện là leaveInInbox
ARCHIVE hiện là archive
DELETE hiện là trash
MARK_READ hiện là markRead

Thay đổi khác

  • Bạn phải tạo và xác minh địa chỉ chuyển tiếp trước khi sử dụng.
  • Bạn có thể quản lý địa chỉ chuyển tiếp bằng tài nguyên settings.forwardingAddresses.

Quản lý chế độ cài đặt POP

Để quản lý quyền truy cập POP trong Gmail API, hãy sử dụng tài nguyên settings.

Chế độ cài đặt cũ Chế độ cài đặt mới Ghi chú
bật accessWindow Bị tắt khi được đặt thành disabled
enableFor accessWindow ALL_MAIL hiện là allMail
hiện là MAIL_FROM_NOW_ONfromNowOn
hành động disposition KEEP hiện là leaveInInbox
ARCHIVE hiện là archive
DELETE hiện là trash
MARK_READ hiện là markRead

Quản lý chế độ cài đặt IMAP

Để quản lý quyền truy cập IMAP trong Gmail API, hãy sử dụng tài nguyên settings.

Chế độ cài đặt cũ Chế độ cài đặt mới
bật đang bật

Quản lý chế độ cài đặt trả lời tự động khi đi vắng

Để quản lý tính năng trả lời tự động khi đi vắng trong API Gmail, hãy sử dụng tài nguyên settings.

Chế độ cài đặt cũ Chế độ cài đặt mới
contactsOnly restrictToContacts
domainOnly restrictToDomain
bật enableAutoReply
endDate endTime
tin nhắn responseBodyHtml
responseBodyPlainText
startDate startTime
chủ đề responseSubject

Quản lý chế độ cài đặt chữ ký

Để quản lý chữ ký email trong Gmail API, hãy sử dụng tài nguyên settings.sendAs.

Chế độ cài đặt cũ Chế độ cài đặt mới
Chữ ký Chữ ký

Thay đổi khác

  • Giờ đây, chữ ký được quản lý theo từng bí danh.

Quản lý chế độ cài đặt ngôn ngữ

Để quản lý chế độ cài đặt ngôn ngữ trong Gmail API, hãy sử dụng tài nguyên settings.

Chế độ cài đặt cũ Chế độ cài đặt mới
language displayLanguage

Để biết thêm thông tin, hãy xem bài viết Quản lý chế độ cài đặt ngôn ngữ.

Quản lý các cài đặt ủy quyền

Để quản lý tính năng uỷ quyền trong Gmail API, hãy sử dụng tài nguyên settings.delegates.

Chế độ cài đặt cũ Chế độ cài đặt mới
xử lý delegateEmail
trạng thái verificationStatus

Thay đổi khác

  • Chung
    • Để sử dụng bất kỳ phương thức uỷ quyền nào (bao gồm cả settings.delegates.create) người dùng uỷ quyền phải được bật cho Gmail. Điều đó có nghĩa là, ví dụ: người dùng uỷ quyền không thể bị tạm ngưng trong Google Workspace.
    • Bạn không thể sử dụng email đại diện làm dữ liệu đầu vào email của người được uỷ quyền cho bất kỳ phương thức mới nào. Người dùng được uỷ quyền phải được tham chiếu theo địa chỉ email chính của họ.
  • settings.delegates.create
    • Giờ đây, bạn có thể sử dụng phương thức này để tạo mối quan hệ uỷ quyền trên nhiều miền thuộc cùng một tổ chức Google Workspace.
    • Giờ đây, bạn có thể sử dụng phương thức này cho những người dùng cần thay đổi mật khẩu vào lần đăng nhập tiếp theo.
    • Nếu thành công, phương thức này sẽ trả về tài nguyên settings.delegates trong nội dung phản hồi, thay vì nội dung phản hồi trống.
    • Nếu người dùng uỷ quyền hoặc người dùng được uỷ quyền bị tắt (ví dụ: bị tạm ngưng trong Google Workspace), thì phương thức này sẽ không thành công và trả về lỗi HTTP 4XX thay vì lỗi HTTP 500.
  • settings.delegates.delete
    • Giờ đây, bạn có thể sử dụng phương thức này để xoá người được uỷ quyền có bất kỳ VerificationStatus, thay vì chỉ những người được uỷ quyền là accepted hoặc expired.
  • settings.delegates.get
    • Đây là một phương thức mới mà bạn có thể ưu tiên hơn settings.delegates.list tuỳ theo nhu cầu.

Quản lý cài đặt chung

Bạn không thể sử dụng chế độ cài đặt chung trong Gmail API.