REST Resource: users.settings.sendAs

Zasób: SendAs

Ustawienia powiązane z aliasem „wyślij jako”, którym może być podstawowy adres logowania powiązany z kontem lub niestandardowy adres nadawcy. Aliasy „Wyślij jako” odpowiadają funkcji „Wyślij pocztę jako” w interfejsie internetowym.

Zapis JSON
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
Pola
sendAsEmail

string

Adres e-mail wyświetlany w nagłówku „Od:” w przypadku e-maili wysyłanych z tego aliasu. Jest tylko do odczytu w przypadku wszystkich operacji oprócz tworzenia.

displayName

string

Nazwa wyświetlana w nagłówku „Od:” w przypadku e-maili wysyłanych z tego aliasu. Jeśli pole „Od” jest puste, Gmail wstawi w nagłówku „Od:” nazwę używaną w podstawowym adresie powiązanym z kontem. Jeśli administrator wyłączył możliwość aktualizowania formatu imion przez użytkowników, prośby o aktualizację tego pola dla podstawowego loginu zostaną dyskretnie odrzucone.

replyToAddress

string

Opcjonalny adres e-mail dołączony do nagłówka „Reply-To:” w przypadku wiadomości wysyłanych z tego aliasu. Jeśli ta wartość będzie pusta, Gmail nie wygeneruje nagłówka „Reply-To:”.

signature

string

Opcjonalny podpis HTML dołączany do wiadomości utworzonych z użyciem tego aliasu w interfejsie internetowym Gmaila. Ten podpis jest dodawany tylko do nowych e-maili.

isPrimary

boolean

Wskazuje, czy jest to podstawowy adres używany do logowania się na konto. Każde konto Gmail ma dokładnie 1 adres główny i nie można go usunąć z kolekcji aliasów „wyślij jako”. To pole jest tylko do odczytu.

isDefault

boolean

Określa, czy ten adres jest wybrany jako domyślny adres w polu „Od:” w sytuacjach, takich jak tworzenie nowej wiadomości czy wysyłanie automatycznej odpowiedzi na czas nieobecności. Każde konto Gmail ma dokładnie jeden domyślny adres „Wyślij jako”, więc jedyna wartość prawna, jaką klienci mogą wpisać w tym polu, to true. Zmiana tej wartości z false na true dla adresu spowoduje, że to pole zmieni się na false w przypadku drugiego poprzedniego adresu domyślnego.

treatAsAlias

boolean

Określa, czy Gmail ma traktować ten adres jako alias podstawowego adresu e-mail użytkownika. To ustawienie dotyczy tylko niestandardowych aliasów „Od”.

smtpMsa

object (SmtpMsa)

Opcjonalna usługa SMTP, która będzie używana jako przekaźnik ruchu wychodzącego dla poczty wysyłanej przy użyciu tego aliasu. Jeśli to pole jest puste, poczta wychodząca będzie wysyłana bezpośrednio z serwerów Gmaila do docelowej usługi SMTP. To ustawienie dotyczy tylko niestandardowych aliasów „Od”.

verificationStatus

enum (VerificationStatus)

Wskazuje, czy ten adres został zweryfikowany i czy można go używać jako aliasu. Tylko do odczytu. To ustawienie dotyczy tylko niestandardowych aliasów „Od”.

SmtpMsa

Konfiguracja komunikacji z usługą SMTP.

Zapis JSON
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Pola
host

string

Nazwa hosta usługi SMTP. To pole jest wymagane.

port

integer

Port usługi SMTP. To pole jest wymagane.

username

string

Nazwa użytkownika, która będzie używana do uwierzytelniania w usłudze SMTP. To pole jest przeznaczone tylko do zapisu, które można określić w żądaniach utworzenia lub zaktualizowania ustawień SendAs. Nigdy nie jest wypełniane w odpowiedziach.

password

string

Hasło, które będzie używane do uwierzytelniania w usłudze SMTP. To pole jest przeznaczone tylko do zapisu, które można określić w żądaniach utworzenia lub zaktualizowania ustawień SendAs. Nigdy nie jest wypełniane w odpowiedziach.

securityMode

enum (SecurityMode)

Protokół, który będzie używany do zabezpieczania komunikacji z usługą SMTP. To pole jest wymagane.

SecurityMode

Protokół, który może służyć do zabezpieczania komunikacji z usługą SMTP.

Wartości w polu enum
securityModeUnspecified Nieokreślony tryb zabezpieczeń.
none Komunikacja ze zdalną usługą SMTP jest niezabezpieczona. Wymaga portu 25.
ssl Komunikacja ze zdalną usługą SMTP jest zabezpieczona za pomocą SSL.
starttls Komunikacja ze zdalną usługą SMTP jest zabezpieczona za pomocą polecenia STARTTLS.

VerificationStatus

Wskazuje, czy własność adresu została potwierdzona pod kątem używania go jako aliasu.

Wartości w polu enum
verificationStatusUnspecified Nieokreślony stan weryfikacji.
accepted Adres jest gotowy do użycia jako alias „wyślij jako”.
pending Adres oczekuje na weryfikację przez właściciela.

Metody

create

Tworzy niestandardowy alias „Od” nadawcy.

delete

Usuwa określony alias „wyślij jako”.

get

Pobiera określony alias „wyślij jako”.

list

Wyświetla aliasy „wyślij jako” dla określonego konta.

patch

Zastosowanie poprawki dla określonego aliasu „wyślij jako”.

update

Aktualizuje alias „wyślij jako”.

verify

Wysyła e-maila weryfikacyjnego na podany alias adresu.