KAC Google Gmail

スレッド、メッセージ、ラベルなどの Gmail メールボックス データを表示および管理できます。

仕様・制限事項

サインインに必要な情報

getToken

アクセストークンを取得します。

パラメータ

レスポンス

gmail_users_getProfile

現在のユーザーの Gmail プロフィールを取得します。

パラメータ

レスポンス

gmail_users_watch

指定されたユーザーのメールボックスでプッシュ通知監視を設定または更新します。

パラメータ

レスポンス

gmail_users_stop

指定されたユーザーのメールボックスのプッシュ通知の受信を停止します。

パラメータ

レスポンス

gmail_users_drafts_delete

指定された下書きを即座に完全に削除します。単にゴミ箱にするだけではありません。

パラメータ

レスポンス

gmail_users_drafts_create

ファイルの Upload はサポートしておりません。「DRAFT」ラベルが付いた新しいドラフトを作成します。

パラメータ

レスポンス

gmail_users_drafts_get

指定されたドラフトを取得します。

パラメータ

レスポンス

gmail_users_drafts_list

ユーザーのメールボックスの下書きを一覧表示します。

パラメータ

レスポンス

gmail_users_drafts_send

ファイルの Upload はサポートしておりません。指定された既存の下書きを「To」、「Cc」、および「Bcc」ヘッダーで受信者に送信します。

パラメータ

レスポンス

gmail_users_drafts_update

ファイルの Upload はサポートしておりません。下書きの内容を置き換えます。

パラメータ

レスポンス

gmail_users_history_list

指定されたメールボックスに対するすべての変更履歴を一覧表示します。履歴結果は時系列順に返されます (`historyId` が増加する)。

パラメータ

レスポンス

gmail_users_messages_trash

指定されたメッセージをゴミ箱に移動します。

パラメータ

レスポンス

gmail_users_messages_untrash

指定されたメッセージをゴミ箱から削除します。

パラメータ

レスポンス

gmail_users_messages_delete

指定されたメッセージを即時かつ永久に削除します。この操作は元に戻すことができません。代わりに `messages.trash` を使用してください。

パラメータ

レスポンス

gmail_users_messages_batchDelete

メッセージ ID に基づいて多数のメッセージを削除します。メッセージがまだ削除されていない、あるいはまったく存在していなかったという保証はありません。

パラメータ

ids: 削除するメッセージの ID。

userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。

access_token: OAuth アクセス トークン。

alt: レスポンスのデータ形式。

callback: JSONP

fields: 部分応答に含めるフィールドを指定するセレクター。

key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。

prettyPrint: インデントと改行を含む応答を返します。

quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。

upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。

uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。

$.xgafv: V1 エラー形式。

レスポンス

gmail_users_messages_import

ファイルの Upload はサポートしておりません。SMTP 経由の受信と同様の標準的な電子メール配信スキャンと分類を使用して、メッセージをこのユーザーのメールボックスのみにインポートします。この方法は SPF チェックを実行しないため、ドメイン スプーフィングを実行しようとするスパム メッセージなど、一部のスパム メッセージに対しては機能しない可能性があります。このメソッドはメッセージを送信しません。

パラメータ

レスポンス

gmail_users_messages_insert

ファイルの Upload はサポートしておりません。「IMAP APPEND」と同様に、ほとんどのスキャンと分類をバイパスして、このユーザーのメールボックスのみにメッセージを直接挿入します。メッセージは送信しません。

パラメータ

レスポンス

gmail_users_messages_get

指定されたメッセージを取得します。

パラメータ

レスポンス

gmail_users_messages_send

ファイルの Upload はサポートしておりません。指定されたメッセージを「To」、「Cc」、および「Bcc」ヘッダーで受信者に送信します。使用例については、[メールの送信](https://developers.google.com/gmail/api/guides/sending)をご覧ください。

パラメータ

レスポンス

gmail_users_messages_list

ユーザーのメールボックス内のメッセージを一覧表示します。

パラメータ

レスポンス

gmail_users_messages_modify

指定されたメッセージのラベルを変更します。

パラメータ

レスポンス

gmail_users_messages_batchModify

指定されたメッセージのラベルを変更します。

パラメータ

レスポンス

gmail_users_messages_attachments_g

指定されたメッセージの添付ファイルを取得します。

パラメータ

レスポンス

gmail_users_labels_create

新しいラベルを作成します。

パラメータ

レスポンス

gmail_users_labels_delete

指定されたラベルを即時かつ永久に削除し、そのラベルが適用されているメッセージおよびスレッドから削除します。

パラメータ

レスポンス

gmail_users_labels_get

指定されたラベルを取得します。

パラメータ

レスポンス

gmail_users_labels_list

ユーザーのメールボックス内のすべてのラベルを一覧表示します。

パラメータ

レスポンス

gmail_users_labels_update

指定されたラベルを更新します。

パラメータ

レスポンス

gmail_users_labels_patch

指定されたラベルにパッチを適用します。

パラメータ

レスポンス

gmail_users_threads_trash

指定したスレッドをゴミ箱に移動します。スレッドに属するメッセージもすべてゴミ箱に移動されます。

パラメータ

レスポンス

gmail_users_threads_untrash

指定されたスレッドをゴミ箱から削除します。スレッドに属するメッセージもゴミ箱から削除されます。

パラメータ

レスポンス

gmail_users_threads_delete

指定されたスレッドを即時かつ永久に削除します。スレッドに属するメッセージもすべて削除されます。この操作は元に戻すことができません。代わりに「threads.trash」を使用してください。

パラメータ

レスポンス

gmail_users_threads_get

指定されたスレッドを取得します。

パラメータ

レスポンス

gmail_users_threads_list

ユーザーのメールボックス内のスレッドを一覧表示します。

パラメータ

レスポンス

gmail_users_threads_modify

スレッドに適用されるラベルを変更します。これはスレッド内のすべてのメッセージに適用されます。

パラメータ

レスポンス

gmail_users_settings_getImap

IMAP設定を取得します。

パラメータ

レスポンス

gmail_users_settings_updateImap

IMAP設定を更新します。

パラメータ

レスポンス

gmail_users_settings_getPop

POP設定を取得します。

パラメータ

レスポンス

gmail_users_settings_updatePop

POP設定を更新します。

パラメータ

レスポンス

gmail_users_settings_getVacation

休暇応答者の設定を取得します。

パラメータ

レスポンス

gmail_users_settings_updateVacation

休暇応答者の設定を更新します。

パラメータ

レスポンス

gmail_users_settings_getLanguage

言語設定を取得します。

パラメータ

userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。

access_token: OAuth アクセス トークン。

alt: レスポンスのデータ形式。

callback: JSONP

fields: 部分応答に含めるフィールドを指定するセレクター。

key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。

prettyPrint: インデントと改行を含む応答を返します。

quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。

upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。

uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。

$.xgafv: V1 エラー形式。

レスポンス

gmail_users_settings_updateLanguage

言語設定を更新します。成功した場合、返されるオブジェクトにはユーザー用に保存された `displayLanguage` が含まれますが、これはリクエストに渡された値とは異なる場合があります。これは、要求された「displayLanguage」が Gmail で直接サポートされていない可能性がありますが、類似したバリアントがあり、代わりにそのバリアントが選択されて保存される可能性があるためです。

パラメータ

レスポンス

gmail_users_settings_updateAutoForwar

指定されたアカウントの自動転送設定を更新します。自動転送が有効な場合は、検証済みの転送アドレスを指定する必要があります。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。

パラメータ

レスポンス

gmail_users_settings_sendAs_list

指定されたアカウントの送信者エイリアスを一覧表示します。結果には、アカウントに関連付けられたプライマリ送信者アドレスとカスタムの「差出人」エイリアスが含まれます。

パラメータ

レスポンス

gmail_users_settings_sendAs_get

指定された送信エイリアスを取得します。指定されたアドレスがコレクションのメンバーではない場合、HTTP 404 エラーで失敗します。

パラメータ

$.xgafv: V1 エラー形式。

レスポンス

gmail_users_settings_sendAs_create

カスタムの「送信元」送信エイリアスを作成します。 SMTP MSA が指定されている場合、Gmail はエイリアスを作成する前に SMTP サービスに接続して構成を検証しようとします。エイリアスの所有権の検証が必要な場合、メッセージが電子メール アドレスに送信され、リソースの検証ステータスが「保留中」に設定されます。それ以外の場合、リソースは検証ステータスが「accepted」に設定されて作成されます。署名が提供されている場合、Gmail はエイリアスを使用して保存する前に HTML をサニタイズします。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。

パラメータ

レスポンス

gmail_users_settings_sendAs_update

send-as エイリアスを更新します。署名が提供されている場合、Gmail はエイリアスを使用して保存する前に HTML をサニタイズします。アカウントのプライマリ アドレス以外のアドレスは、ドメイン全体の権限を委任されたサービス アカウント クライアントによってのみ更新できます。

パラメータ

レスポンス

gmail_users_settings_sendAs_patch

指定された送信者エイリアスにパッチを適用します。

パラメータ

レスポンス

gmail_users_settings_sendAs_delete

指定された送信者エイリアスを削除します。使用するために必要な検証をすべて取り消します。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。

パラメータ

レスポンス

gmail_users_settings_sendAs_verify

指定されたエイリアス送信アドレスに確認電子メールを送信します。検証ステータスは「保留中」でなければなりません。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。

パラメータ

レスポンス

gmail_users_settings_sendAs_smimel (1)

指定された send-as エイリアスの S/MIME 構成を一覧表示します。

パラメータ

レスポンス

gmail_users_settings_sendAs_smimel (2)

指定された send-as エイリアスの指定された S/MIME 構成を取得します。

パラメータ

レスポンス

gmail_users_settings_sendAs_smimel (3)

指定された send-as エイリアスの指定された S/MIME 構成を削除します。

パラメータ

レスポンス

gmail_users_settings_sendAs_smimel (4)

指定された send-as エイリアスのデフォルトの S/MIME 構成を設定します。

パラメータ

レスポンス

gmail_users_settings_cse_identitie (1)

ユーザー アカウントからメールを送信する権限のあるクライアント側の暗号化 ID を作成および構成します。 Google は、Google Workspace 組織内のユーザーがメールを暗号化して ID に送信できるように、S/MIME 証明書をドメイン全体の共有ディレクトリに公開します。

パラメータ

レスポンス

gmail_users_settings_cse_identitie (2)

クライアント側の暗号化 ID を削除します。認証されたユーザーは、その ID を使用して暗号化されたメッセージを送信できなくなります。 ID を削除した後に復元することはできません。代わりに、CreateCseIdentity メソッドを使用して、同じ構成で別の ID を作成します。

パラメータ

レスポンス

gmail_users_settings_cse_identitie (3)

クライアント側の暗号化 ID 構成を取得します。

パラメータ

レスポンス

gmail_users_settings_cse_identitie (4)

認証されたユーザーのクライアント側で暗号化された ID をリストします。

パラメータ

レスポンス

gmail_users_settings_cse_identitie (5)

別のキー ペアを既存のクライアント側暗号化 ID に関連付けます。更新されたキー ペアは、Google の [S/MIME 証明書プロファイル](https://support.google.com/a/answer/7300887) に対して検証する必要があります。

パラメータ

レスポンス

gmail_users_settings_cse_keypairs (1)

認証されたユーザーのクライアント側暗号化 S/MIME 公開キー証明書チェーンと秘密キー メタデータを作成してアップロードします。

パラメータ

レスポンス

gmail_users_settings_cse_keypairs (2)

クライアント側の暗号化キーのペアをオフにします。認証されたユーザーは、キー ペアを使用して受信 CSE メッセージ テキストを復号したり、送信 CSE メールに署名したりできなくなります。アクセスを回復するには、EnableCseKeyPair を使用してキー ペアをオンにします。 30 日後、ObliterateCseKeyPair メソッドを使用してキー ペアを完全に削除できます。

パラメータ

レスポンス

gmail_users_settings_cse_keypairs (3)

オフになっていたクライアント側の暗号化キーのペアをオンにします。キー ペアは、関連付けられたクライアント側の暗号化 ID に対して再びアクティブになります。

パラメータ

レスポンス

gmail_users_settings_cse_keypairs (4)

既存のクライアント側の暗号化キーのペアを取得します。

パラメータ

レスポンス

gmail_users_settings_cse_keypairs (5)

認証されたユーザーのクライアント側の暗号化キーのペアを一覧表示します。

パラメータ

レスポンス

gmail_users_settings_cse_keypairs (6)

クライアント側の暗号化キーのペアを永久的かつ即時に削除します。完全に削除できるのは、30 日以上オフになっているキー ペアのみです。キー ペアをオフにするには、DisableCseKeyPair メソッドを使用します。 Gmail では、消去されたキーで暗号化されたメッセージを復元したり復号したりすることはできません。認証されたユーザーと Google Workspace 管理者は、暗号化されたメッセージを読み取るアクセス権を失います。

パラメータ

レスポンスa

gmail_users_settings_filters_list

Gmail ユーザーのメッセージ フィルターを一覧表示します。

パラメータ

レスポンス

gmail_users_settings_filters_get

フィルターを取得します。

パラメータ