REST Resource: users.settings.sendAs

リソース: SendA

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

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:」ヘッダーに表示される名前。カスタムの「差出人」アドレスでこのフィールドが空の場合、Gmail で「From:」ヘッダーに、アカウントに関連付けられているメインのアドレスとして使用されている名前が入力されます。管理者が名前の形式を更新する機能を無効にしている場合、メイン ログインのこのフィールドの更新リクエストは通知なく失敗します。
replyToAddress

string

このエイリアスを使用して送信されるメールの「Reply-To:」ヘッダーに含まれるオプションのメールアドレス。このフィールドが空の場合、「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 このアドレスは所有者による確認待ちです。

Methods

create

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

delete

 指定した送信元エイリアスを削除します。

get

 指定された送信元エイリアスを取得します。

list

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

patch

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

update

 送信元エイリアスを更新します。

verify

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