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 会使用与账号关联的主地址所用的名称填充“From:”标头。如果管理员停用了用户更新姓名格式的功能,则系统会静默拒绝针对主要登录名更新此字段的请求。

replyToAddress

string

可选电子邮件地址,用于在使用此别名发送的邮件的“Reply-To:”标头中添加。如果此字段为空,Gmail 将不会生成“Reply-To:”标头。

signature

string

可选的 HTML 签名,会在 Gmail 网页界面中使用此别名撰写的邮件中显示。此签名只会添加到新电子邮件中。

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 使用 STARTTLS 保护与远程 SMTP 服务的通信。

VerificationStatus

指示地址的所有权是否已通过验证,以便将其用作“发件人别名”。

枚举
verificationStatusUnspecified 未指定验证状态。
accepted 该地址可以用作“以某人名义发送”别名。
pending 该地址正在等待所有者验证。

方法

create

创建自定义“发件人”别名。

delete

删除指定的“以某人名义发送”别名。

get

获取指定的“以某人名义发送”别名。

list

列出指定账号的“以某人名义发送”别名。

patch

修补指定的“用以下地址发送邮件”别名。

update

更新“以某人名义发送”别名。

verify

向指定的“以此别名发送”地址发送验证电子邮件。