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

Необязательный адрес электронной почты, который включается в заголовок "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. Обязательно.

Режим безопасности

Протокол, который может использоваться для обеспечения безопасности связи со службой SMTP.

Перечисления
securityModeUnspecified Неуказанный режим безопасности.
none Связь с удалённым SMTP-сервисом небезопасна. Требуется порт 25.
ssl Связь с удалённым SMTP-сервисом защищёна с помощью SSL.
starttls Связь с удалённым SMTP-сервисом защищёна с помощью протокола STARTTLS.

Статус проверки

Указывает, подтверждено ли право собственности на адрес для его использования в качестве псевдонима для отправки сообщений.

Перечисления
verificationStatusUnspecified Статус проверки не указан.
accepted Адрес готов к использованию в качестве псевдонима для отправки сообщений.
pending Адрес ожидает подтверждения от владельца.

Методы

create

 Создает пользовательский псевдоним отправителя "from".

delete

 Удаляет указанный псевдоним для отправки.

get

 Получает указанный псевдоним для отправки.

list

 Отображает список псевдонимов для отправки сообщений с указанного аккаунта.

patch

 Исправьте указанный псевдоним для отправки.

update

 Обновляет псевдоним для отправки.

verify

 Отправляет письмо с подтверждением на указанный адрес электронной почты, используемый в качестве псевдонима для отправки.