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 でこのアドレスをユーザーのメインのメールアドレスの エイリアスとして扱うかどうか。この設定はカスタムの「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

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