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 )

Указывает, был ли этот адрес проверен для использования в качестве псевдонима для отправки. Только для чтения. Этот параметр применяется только к пользовательским псевдонимам «от».

СмтпМса

Конфигурация для связи со службой 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

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