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.forwardingAddresses

方法
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
從垃圾桶中移除指定的執行緒。