REST Resource: users.settings.sendAs

资源:SendAs

与“用以下地址发送邮件”别名关联的设置,该别名可以是与账号关联的主登录地址,也可以是自定义的“发件人”地址。“用以下地址发送邮件”别名对应于 Web 界面中的“用以下地址发送邮件”功能。“用以下地址发送邮件”别名必须是有效的电子邮件地址。

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 将不会生成“回复至:”标头。

signature

string

一个可选的 HTML 签名,该签名包含在 Gmail Web 界面中使用此别名撰写的邮件中。此签名仅添加到新电子邮件中。

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

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