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

使用這個別名傳送郵件時，會顯示在「寄件者：」標頭中的電子郵件地址。除了建立作業之外，其他所有作業均為唯讀。
displayName

string

使用這個別名傳送郵件時，會顯示在「寄件者：」標頭中的名稱。如果自訂「寄件者」地址為空白，Gmail 會在「寄件者：」標頭中填入與帳戶相關聯的主要地址的名稱。如果管理員已停用使用者更新名稱格式功能，則針對主要登入帳戶更新這個欄位的請求會在背景失敗。
replyToAddress

string

使用這個別名傳送郵件時，在「Reply-To:」標頭中加入的選用電子郵件地址。如果這個值為空白，Gmail 就不會產生「Reply-To:」標頭。
signature

string

在 Gmail 網頁介面中，使用這個別名撰寫的郵件會附上這個選用的 HTML 簽名。這份簽名只會新增至新電子郵件。
isPrimary

boolean

這個地址是否為用來登入帳戶的主要地址。每個 Gmail 帳戶都只有一個主要地址，而且無法從「以其他身分傳送」別名集合中刪除。這是唯讀欄位。
isDefault

boolean

在撰寫新訊息或傳送休假自動回覆訊息等情況下，系統是否會選取這個地址做為預設的「寄件者」地址。每個 Gmail 帳戶都有一個預設的傳送者地址，因此用戶端只能將 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

 建立自訂「寄件者」別名。

delete

 刪除指定的「以某人身分寄件」別名。

get

 取得指定的傳送者別名。

list

 列出指定帳戶的「以身分寄件」別名。

patch

 修補指定的寄件者別名。

update

 更新「以身分寄送」別名。

verify

 將驗證電子郵件傳送至指定的「傳送為」別名地址。