REST Resource: users.settings.sendAs

資源:SendAs

與「以這個地址寄送郵件」別名相關聯的設定,可以是與帳戶相關聯的主要登入地址,或是自訂的「寄件者」讓我們看看 DNS 解析 進一步探索內部和外部位址「以這個地址寄送郵件」功能相當於網頁介面中的「以這個地址寄送郵件」功能。

JSON 表示法
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
欄位
sendAsEmail

string

「寄件者:」中顯示的電子郵件地址標頭。對所有作業來說都是唯讀狀態,除了 create 以外。

displayName

string

顯示在「寄件者:」中的名稱標頭。自訂「寄件者」地址時,Gmail 會將寄件者欄位填入 [寄件者:] 欄位標頭,與帳戶相關聯的主要地址名稱。如果管理員已停用使用者更新姓名格式的功能,那麼在主要登入位置更新這個欄位的要求就會失敗,而且不會顯示相關通知。

replyToAddress

string

選擇性電子郵件地址,包含在「回覆地址」中:標頭。如果留空,Gmail 就不會產生「回覆」:標題。

signature

string

選用的 HTML 簽名,包含在 Gmail 網頁 UI 中以這個別名撰寫的郵件中。這個簽名僅適用於新電子郵件。

isPrimary

boolean

這個地址是否為登入帳戶時使用的主要地址。每個 Gmail 帳戶只能有一個主要地址,而且無法從寄件者別名集合中刪除。這是唯讀欄位。

isDefault

boolean

如果選取這個地址做為預設的「寄件者:」地址,例如撰寫新郵件或傳送休假自動回覆。每個 Gmail 帳戶都只有一個預設的寄件地址,因此用戶端只能寫入這個欄位的法定值是 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 服務與遠端 SMTP 服務的通訊行為受到 STARTTLS 保護。

VerificationStatus

指出地址的擁有權是否通過驗證,可做為傳送別名使用。

列舉
verificationStatusUnspecified 未指定的驗證狀態。
accepted 該地址已可作為寄送別名地址使用。
pending 地址正在等待擁有者驗證。

方法

create

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

delete

刪除指定的「以這個地址寄送郵件」別名。

get

取得指定的「以這個地址寄送郵件」別名。

list

列出指定帳戶的傳送做為別名。

patch

修補指定的 send-as 別名。

update

更新寄送地址別名。

verify

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