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:」標頭中顯示的名稱。如果自訂「寄件者」地址留空,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 是否應 將這個地址視為使用者主要電子郵件地址的別名。這項設定僅適用於自訂「寄件者」別名。

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 地址正在等待擁有者驗證。

方法

create

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

delete

刪除指定的寄件別名。

get

取得指定的寄件別名。

list

列出指定帳戶的寄件別名。

patch

修補指定的傳送別名。

update

更新寄件別名。

verify

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