REST Resource: users.settings.sendAs

リソース: SendAs

「名前」のエイリアスに関連付けられた設定。アカウントに関連付けられたメインのログイン アドレスまたはカスタムの「From」アドレスのいずれかになります。「名前」のエイリアスは、「名前」機能に対応しています。「名前」のエイリアスは有効なメールアドレスである必要があります。

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 がこのアドレスをユーザーのメインのメールアドレスのエイリアスとして 扱うかどうか。この設定は、カスタムの「From」エイリアスにのみ適用されます。
smtpMsa

object (SmtpMsa)

このエイリアスを使用して送信されたメールの送信リレーとして使用される省略可能な SMTP サービス。これが空欄の場合、送信メールは Gmail のサーバーから宛先の SMTP サービスに直接送信されます。この設定は、カスタムの「From」エイリアスにのみ適用されます。
verificationStatus

enum (VerificationStatus)

このアドレスが「名前」のエイリアスとして使用するために確認されているかどうかを示します。読み取り専用。この設定は、カスタムの「From」エイリアスにのみ適用されます。

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

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