Gmail API を使用すると、Gmail のメールボックス データ（スレッド、メッセージ、ラベルなど）の表示と管理を行えます。
- REST リソース: v1.users
- REST リソース: v1.users.Drafts
- REST リソース: v1.users.history
- REST リソース: v1.users.labels
- REST リソース: v1.users.messages
- REST リソース: v1.users.messages.attachments
- REST リソース: v1.users.settings
- REST リソース: v1.users.settings.cse.identities
- REST リソース: v1.users.settings.cse.keypairs
- REST リソース: v1.users.settings.delegates
- REST リソース: v1.users.settings.filters
- REST リソース: v1.users.settings.forwardingAddress
- REST リソース: v1.users.settings.sendAs
- REST リソース: v1.users.settings.sendAs.smimeInfo
- REST リソース: v1.users.threads
サービス: 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 To、Cc、Bcc ヘッダーで、指定された既存の下書きを受信者に送信します。 |
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}/messagesPOST /upload/gmail/v1/users/{userId}/messagesIMAP 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/sendTo、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
| 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 クライアントサイド暗号化の 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.forwardingAddress
| 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 指定したスレッドをゴミ箱から削除します。 |