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.forwardingAddresses
- 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
| メソッド | |
|---|---|
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 ユーザー アカウントからメールを送信する権限のあるクライアントサイド暗号化 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
| メソッド | |
|---|---|
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 指定されたスレッドをゴミ箱から削除します。 |