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

对于使用此别名发送的邮件,其“回复:”标头中包含可选的电子邮件地址。如果此字段为空,则 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 服务通信的协议。必需。

安全模式

可用于保护与 SMTP 服务通信的协议。

枚举
securityModeUnspecified 未指定安全模式。
none 与远程 SMTP 服务的通信不安全。需要端口 25。
ssl 与远程 SMTP 服务的通信受 SSL 保护。
starttls 与远程 SMTP 服务的通信受 STARTTLS 保护。

验证状态

表示地址的所有权是否已经过验证,可用作“发送身份”别名。

枚举
verificationStatusUnspecified 未指定验证状态。
accepted 该地址已可用作发送身份别名。
pending 该地址正在等待所有者验证。

方法

create

创建自定义“发件人”地址。

delete

删除指定的发送身份别名。

get

获取指定的发送身份别名。

list

列出指定帐号的发送身份别名。

patch

修补指定的“发送身份”别名。

update

用于更新“发送身份”别名。

verify

向指定的“用以下地址发送邮件”别名地址发送验证邮件。