REST Resource: users.settings.sendAs

Zasób: SendAs

Ustawienia powiązane z aliasem „Wyślij jako”, który może być podstawowym adresem logowania powiązanym z kontem lub niestandardowym adresem „od”. Aliasy „Wyślij jako” odpowiadają funkcji „Wyślij 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, który pojawia się w nagłówku „Od:” w przypadku wiadomości wysłanej za pomocą tego aliasu. Jest to tylko do odczytu we wszystkich operacjach z wyjątkiem tworzenia.

displayName

string

Nazwa, która jest wyświetlana w nagłówku „Od:” w przypadku wiadomości wysłanej za pomocą tego aliasu. W przypadku niestandardowych adresów „od” Gmail wypełnia nagłówek „Od:” nazwą używaną dla adresu głównego powiązanego z kontem. Jeśli administrator wyłączy możliwość aktualizowania formatu nazwy przez użytkowników, żądania aktualizacji tego pola w przypadku głównego identyfikatora logowania nie będą powodować żadnych komunikatów.

replyToAddress

string

Opcjonalny adres e-mail, który jest dołączany do nagłówka „Odpowiedz:” w przypadku wiadomości wysłanej za pomocą tego aliasu. Jeśli to pole jest puste, Gmail nie wygeneruje nagłówka „Odpowiedź:”.

signature

string

Opcjonalny podpis w formacie HTML, który jest dołączany do wiadomości utworzonych za pomocą tego aliasu w interfejsie internetowym Gmaila. Ta sygnatura jest dodawana tylko do nowych e-maili.

isPrimary

boolean

Czy ten adres jest podstawowym adresem używanym do logowania się na konto. Każde konto Gmail ma dokładnie jeden adres podstawowy, który nie może zostać usunięty z kolekcji aliasów wysyłania jako. To pole jest tylko do odczytu.

isDefault

boolean

Określa, czy ten adres jest wybrany jako domyślny adres „Od” w sytuacjach takich jak tworzenie nowej wiadomości lub wysyłanie automatycznej odpowiedzi na czas nieobecności. Każde konto Gmail ma dokładnie 1 domyślny adres wysyłania, więc jedyną prawidłową wartość, którą klienci mogą wpisać w tym polu, jest true. Zmiana tego ustawienia z false na true spowoduje, że to pole stanie się false dla innego poprzedniego adresu domyślnego.

treatAsAlias

boolean

Czy Gmail powinien 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 serwer poczty wychodzącej dla poczty wysyłanej za pomocą 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 pod kątem użycia jako alias wysyłania. 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. Wymagane.

port

integer

Port usługi SMTP. Wymagane.

username

string

Nazwa użytkownika, która będzie używana do uwierzytelniania w usłudze SMTP. To pole służy tylko do zapisu. Można je określić w żądaniach tworzenia lub aktualizowania ustawień SendAs. Nigdy nie jest wypełniane w odpowiedziach.

password

string

Hasło używane do uwierzytelniania w usłudze SMTP. To pole służy tylko do zapisu. Można je określić w żądaniach tworzenia lub aktualizowania 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. Wymagane.

SecurityMode

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

Wartości w polu enum
securityModeUnspecified Nieokreślony tryb zabezpieczeń.
none Komunikacja z usługą SMTP zdalnego nie jest szyfrowana. Wymaga portu 25.
ssl Komunikacja z usługą SMTP zdalnego jest szyfrowana za pomocą protokołu SSL.
starttls Komunikacja z usługą SMTP zdalnego jest chroniona za pomocą protokołu STARTTLS.

VerificationStatus

Wskazuje, czy własność adresu została zweryfikowana na potrzeby użycia go jako aliasu do wysyłania.

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

Metody

create

Tworzy niestandardowy alias „from” do wysyłania.

delete

Usunięcie określonego aliasu nadawcy.

get

Pobiera podany alias wysyłania jako.

list

Wyświetla listę aliasów wysyłania jako na określonym koncie.

patch

Wprowadź poprawkę w określonym aliasie „Wyślij jako”.

update

Aktualizuje alias „wyślij jako”.

verify

Wysyła e-maila weryfikacyjnego na adres aliasu send-as.