REST Resource: users.settings.sendAs

リソース: SendAs

送信者エイリアスに関連付けられた設定。これは、アカウントに関連付けられているメインのログイン アドレスまたはカスタムの「差出人」アドレスのいずれかです。送信元エイリアスは、ウェブ インターフェースの「名前」機能に対応しています。

JSON 表現
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
フィールド
sendAsEmail

string

このエイリアスを使用して送信されたメールの [From:] ヘッダーに表示されるメールアドレス。これは、作成を除くすべてのオペレーションで読み取り専用です。

displayName

string

このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示される名前。カスタムの「From」アドレスが空の場合、Gmail ではアカウントに関連付けられているメインのアドレスに使用されている名前が「From:」ヘッダーに入力されます。管理者がユーザーの名前形式の更新機能を無効にしている場合、プライマリ ログインのこのフィールドを更新するリクエストは、通知なく失敗します。

replyToAddress

string

このエイリアスを使用して送信されたメールの「Reply-To:」ヘッダーに含まれるメールアドレス(省略可)。空白の場合、Gmail は「Reply-To:」ヘッダーを生成しません。

signature

string

Gmail のウェブ UI でこのエイリアスを使用して作成したメールに含まれる HTML 署名(省略可)。この署名は新しいメールにのみ追加されます。

isPrimary

boolean

このアドレスがアカウントへのログインに使用されているメインのアドレスかどうか。すべての Gmail アカウントには 1 つのメイン アドレスがあり、送信元エイリアスのコレクションから削除することはできません。このフィールドは読み取り専用です。

isDefault

boolean

新しいメールの作成や休暇中の自動返信の送信などの場合、このアドレスがデフォルトの「From:」アドレスとして選択されるかどうか。すべての Gmail アカウントにはデフォルトの送信元アドレスが 1 つだけ設定されているため、クライアントがこのフィールドに書き込むことができる有効な値は true のみです。住所のこのフィールドを false から true に変更すると、他の以前のデフォルトの住所のこのフィールドは false になります。

treatAsAlias

boolean

Gmail でこのアドレスをユーザーのメインのメールアドレスの エイリアスとして扱うかどうか。この設定は、カスタムの「差出人」エイリアスにのみ適用されます。

smtpMsa

object (SmtpMsa)

このエイリアスを使用して送信されるメールの送信リレーとして使用されるオプションの SMTP サービス。空白の場合、送信メールは Gmail のサーバーから宛先の SMTP サービスに直接送信されます。この設定は、カスタムの「差出人」エイリアスにのみ適用されます。

verificationStatus

enum (VerificationStatus)

このアドレスが「送信者名」エイリアスとして使用可能かどうかを示します。読み取り専用。この設定は、カスタムの「差出人」エイリアスにのみ適用されます。

SmtpMsa

SMTP サービスとの通信の構成。

JSON 表現
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
フィールド
host

string

SMTP サービスのホスト名。必須。

port

integer

SMTP サービスのポート。必須。

username

string

SMTP サービスでの認証に使用するユーザー名。これは書き込み専用のフィールドで、SendAs 設定を作成または更新するリクエストで指定できます。レスポンスには入力されません。

password

string

SMTP サービスでの認証に使用するパスワード。これは書き込み専用のフィールドで、SendAs 設定を作成または更新するリクエストで指定できます。レスポンスには入力されません。

securityMode

enum (SecurityMode)

SMTP サービスとの通信の保護に使用するプロトコル。必須。

SecurityMode

SMTP サービスとの通信を保護するために使用できるプロトコル。

列挙型
securityModeUnspecified セキュリティ モードが指定されていません。
none リモート SMTP サービスとの通信は保護されていません。ポート 25 が必要です。
ssl リモート SMTP サービスとの通信は SSL を使用して保護されます。
starttls リモート SMTP サービスとの通信は STARTTLS を使用して保護されます。

VerificationStatus

送信元として使用するアドレスの所有権が確認されているかどうかを示します。

列挙型
verificationStatusUnspecified 未指定の確認ステータス。
accepted 住所は、送信者名のエイリアスとして使用できるようになります。
pending 住所は所有者による確認待ちです。

メソッド

create

カスタムの「From」の送信元エイリアスを作成します。

delete

指定された「送信者として」エイリアスを削除します。

get

指定された「送信者名」エイリアスを取得します。

list

指定したアカウントの「送信者名」エイリアスを一覧表示します。

patch

指定された「名前」エイリアスにパッチを適用します。

update

送信者名のエイリアスを更新します。

verify

指定された「送信者名」エイリアス アドレスに確認メールを送信します。