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

使用此别名发送的邮件的“发件人:”标头中显示的电子邮件地址。对于除 create 之外的所有操作,该值都是只读的。

displayName

string

使用此别名发送的邮件的“发件人:”标头中显示的名称。对于自定义“发件人”地址,当此字段为空时,Gmail 将使用与帐号关联的主地址所使用的名称填充“发件人:”标头。如果管理员停用了用户更新姓名格式的功能,则为主要登录信息更新此字段的请求将静默失败。

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

向指定的发送身份别名地址发送验证邮件。