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 就不會產生「回覆地址:」標題。

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 服務的使用者名稱。這是僅供寫入的欄位,可在要求中指定,用於建立或更新「以其他地址或別名傳送郵件」設定;這個欄位絕不會在回應中填入資料。

password

string

用於 SMTP 服務驗證的密碼。這是僅供寫入的欄位,可在建立或更新「以其他地址或別名傳送郵件」設定的要求中指定,但不會在回應中填入。

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

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