Gmail API

Gmail API 可讓您查看及管理 Gmail 信箱資料，例如會話串、郵件和標籤。

服務：gmail.googleapis.com

如要呼叫這項服務，建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫來呼叫此服務，請在發出 API 要求時提供下列資訊。

探索文件

探索文件是一種機器可解讀的規格，用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式，以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件：

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點，且下方的 URI 皆以此服務端點為基準：

  • https://gmail.googleapis.com

REST 資源：v1.users

方法
getProfile GET /gmail/v1/users/{userId}/profile
取得目前使用者的 Gmail 個人資料。
stop POST /gmail/v1/users/{userId}/stop
停止接收指定使用者信箱的推播通知。
watch POST /gmail/v1/users/{userId}/watch
設定或更新使用者信箱的推播通知手錶。

REST 資源：v1.users.drafts

方法
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
使用 DRAFT 標籤建立新草稿。
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
立即永久刪除指定草稿。
get GET /gmail/v1/users/{userId}/drafts/{id}
取得指定草稿。
list GET /gmail/v1/users/{userId}/drafts
在使用者信箱中列出草稿。
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
將指定的現有草稿傳送給「To」、「Cc」和「Bcc」標頭中的收件者。
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
取代草稿的內容。

REST 資源：v1.users.history

方法
list GET /gmail/v1/users/{userId}/history
列出指定信箱的所有變更記錄。

REST 資源：v1.users.labels

方法
create POST /gmail/v1/users/{userId}/labels
建立新標籤。
delete DELETE /gmail/v1/users/{userId}/labels/{id}
立即永久刪除指定標籤，並將其從已套用該標籤的郵件和會話串中移除。
get GET /gmail/v1/users/{userId}/labels/{id}
取得指定標籤。
list GET /gmail/v1/users/{userId}/labels
列出使用者信箱中的所有標籤。
patch PATCH /gmail/v1/users/{userId}/labels/{id}
修補指定標籤。
update PUT /gmail/v1/users/{userId}/labels/{id}
更新指定標籤。

REST 資源：v1.users.messages

方法
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
依照郵件 ID 刪除多封郵件。
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
修改指定訊息中的標籤。
delete DELETE /gmail/v1/users/{userId}/messages/{id}
立即永久刪除指定訊息。
get GET /gmail/v1/users/{userId}/messages/{id}
取得指定訊息。
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
將郵件只匯入這位使用者的信箱，標準郵件傳送掃描和分類功能與透過 SMTP 接收類似。
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
直接將郵件插入這位使用者的信箱 (類似於 IMAP APPEND)，類似於大部分的掃描和分類設定。
list GET /gmail/v1/users/{userId}/messages
列出使用者的信箱中的郵件。
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
修改指定訊息中的標籤。
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
將指定郵件傳送給「To」、「Cc」和「Bcc」標頭中的收件者。
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
將指定訊息移至垃圾桶。
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
將指定郵件從垃圾桶中移除。

REST 資源：v1.users.messages.attachments

方法
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
取得指定訊息附件。

REST 資源：v1.users.settings

方法
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
取得指定帳戶的自動轉寄設定。
getImap GET /gmail/v1/users/{userId}/settings/imap
取得 IMAP 設定。
getLanguage GET /gmail/v1/users/{userId}/settings/language
取得語言設定。
getPop GET /gmail/v1/users/{userId}/settings/pop
取得 POP 設定。
getVacation GET /gmail/v1/users/{userId}/settings/vacation
取得休假回覆設定。
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
更新指定帳戶的自動轉寄設定。
updateImap PUT /gmail/v1/users/{userId}/settings/imap
更新 IMAP 設定。
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
更新語言設定。
updatePop PUT /gmail/v1/users/{userId}/settings/pop
更新 POP 設定。
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
更新休假回覆設定。

REST 資源：v1.users.settings.cse.identities

方法
create POST /gmail/v1/users/{userId}/settings/cse/identities
建立及設定用戶端加密身分，授權身分會從使用者帳戶傳送郵件。
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
刪除用戶端加密身分。
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
擷取用戶端加密身分設定。
list GET /gmail/v1/users/{userId}/settings/cse/identities
列出已驗證使用者的用戶端加密身分。
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
將其他金鑰組與現有的用戶端加密身分建立關聯。

REST 資源：v1.users.settings.cse.keypairs

方法
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
為已驗證的使用者建立及上傳用戶端加密 S/MIME 公開金鑰憑證鏈結和私密金鑰中繼資料。
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
關閉用戶端加密金鑰組合。
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
開啟已停用的加密金鑰。
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
擷取現有的用戶端加密金鑰組合。
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
列出已驗證使用者的用戶端加密金鑰組合。
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
立即永久刪除用戶端加密金鑰組合。

REST 資源：v1.users.settings.delegates

方法
create POST /gmail/v1/users/{userId}/settings/delegates
新增驗證狀態直接設為 accepted 的委派對象，不要傳送任何驗證電子郵件。
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
移除指定的委派 (可以是任何驗證狀態)，並撤銷必要的驗證。
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
取得指定委派。
list GET /gmail/v1/users/{userId}/settings/delegates
列出指定帳戶的委派代表。

REST 資源：v1.users.settings.filters

方法
create POST /gmail/v1/users/{userId}/settings/filters
建立篩選器。
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
立即永久刪除指定篩選條件。
get GET /gmail/v1/users/{userId}/settings/filters/{id}
取得篩選器。
list GET /gmail/v1/users/{userId}/settings/filters
列出 Gmail 使用者的郵件篩選器。

REST 資源：v1.users.settings.forwardingAddress

方法
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
建立轉寄地址。
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
刪除指定的轉寄地址，並撤銷任何可能需要的驗證。
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
取得指定的轉寄地址。
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
列出指定帳戶的轉寄地址。

REST 資源：v1.users.settings.sendAs

方法
create POST /gmail/v1/users/{userId}/settings/sendAs
建立自訂「寄件者」寄件地址別名。
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
刪除指定的「寄件地址」別名。
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
取得指定的傳送時別名。
list GET /gmail/v1/users/{userId}/settings/sendAs
列出指定帳戶的寄件地址別名。
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
修補指定的「以寄件地址傳送」的別名。
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
更新寄件地址別名。
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
傳送驗證電子郵件至指定的寄件地址別名地址。

REST 資源：v1.users.settings.sendAs.smimeInfo

方法
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
刪除指定的「寄件地址」別名的 S/MIME 設定。
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
取得指定傳送寄件別名的指定 S/MIME 設定。
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
插入 (上傳) 給指定寄件地址別名的 S/MIME 設定。
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
列出指定寄件地址的 S/MIME 設定。
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
設定指定寄件地址別名的預設 S/MIME 設定。

REST 資源：v1.users.threads

方法
delete DELETE /gmail/v1/users/{userId}/threads/{id}
立即永久刪除指定的執行緒。
get GET /gmail/v1/users/{userId}/threads/{id}
取得指定的執行緒。
list GET /gmail/v1/users/{userId}/threads
列出使用者的信箱中的會話串。
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
修改套用至執行緒的標籤。
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
將指定的對話串移至垃圾桶。
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
將指定的執行緒從垃圾桶中移除。