Gmail API

Gmail API を使用すると、スレッド、メッセージ、ラベルなどの Gmail メールボックス データを表示、管理できます。

サービス: gmail.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストを行う際に次の情報を使用します。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次の検索ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することがあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://gmail.googleapis.com

REST リソース: v1.users

Methods
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

Methods
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
指定された既存の下書きを、ToCcBcc のヘッダーの受信者に送信します。
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
下書きのコンテンツを置き換えます。

REST リソース: v1.users.history

Methods
list GET /gmail/v1/users/{userId}/history
指定されたメールボックスに対するすべての変更の履歴を一覧表示します。

REST リソース: v1.users.labels

Methods
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

Methods
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
ToCcBcc ヘッダーの受信者に指定されたメッセージを送信します。
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
指定したメッセージをゴミ箱に移動します。
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
指定したメッセージをゴミ箱から削除します。

REST リソース: v1.users.messages.attachments

Methods
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
指定されたメッセージの添付ファイルを取得します。

REST リソース: v1.users.settings

Methods
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

Methods
create POST /gmail/v1/users/{userId}/settings/cse/identities
ユーザー アカウントからのメール送信を許可するクライアントサイド暗号化 ID を作成して構成します。
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
クライアントサイド暗号化の ID を削除します。
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
クライアントサイド暗号化 ID の構成を取得します。
list GET /gmail/v1/users/{userId}/settings/cse/identities
認証されたユーザーのクライアントサイド暗号化 ID を一覧表示します。
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
別の鍵ペアを既存のクライアントサイド暗号化 ID に関連付けます。

REST リソース: v1.users.settings.cse.keypairs

Methods
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
認証されたユーザーの、クライアントサイド暗号化(CSE)と 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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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
指定されたスレッドをゴミ箱から削除します。