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

“回复:”中包含的可选电子邮件地址使用此别名发送的邮件的标头。如果此字段为空,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 服务进行身份验证的用户名。此字段是只写字段,可以在创建或更新 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

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