REST Resource: users.settings.sendAs

Ressource: SendAs

Paramètres associés à un alias d'envoi, qui peut être l'adresse de connexion principale associée au compte ou une adresse "de" personnalisée. Les alias d'envoi correspondent à la fonctionnalité Envoyer des e-mails en tant que de l'interface Web.

Représentation JSON
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
Champs
sendAsEmail

string

Adresse e-mail qui s'affiche dans l'en-tête "De" des e-mails envoyés à l'aide de cet alias. Cet état est en lecture seule pour toutes les opérations, sauf la création.

displayName

string

Nom qui apparaît dans l'en-tête "De" des e-mails envoyés à l'aide de cet alias. Si l'adresse "de" personnalisée est vide, Gmail renseigne l'en-tête "De" avec le nom utilisé pour l'adresse principale associée au compte. Si l'administrateur a désactivé la possibilité pour les utilisateurs de modifier le format de leur nom, les demandes de modification de ce champ pour la connexion principale échoueront sans notification.

replyToAddress

string

Adresse e-mail facultative incluse dans l'en-tête "Reply-To:" des e-mails envoyés à l'aide de cet alias. Si ce champ est vide, Gmail ne génère pas d'en-tête "Reply-To".

signature

string

Signature HTML facultative incluse dans les messages rédigés avec cet alias dans l'interface Web de Gmail. Cette signature n'est ajoutée qu'aux nouveaux e-mails.

isPrimary

boolean

Indique si cette adresse est l'adresse principale utilisée pour se connecter au compte. Chaque compte Gmail dispose d'une seule adresse principale, qui ne peut pas être supprimée de la collection d'alias d'envoi. Ce champ est en lecture seule.

isDefault

boolean

Indique si cette adresse est sélectionnée comme adresse "De" par défaut dans des situations telles que la rédaction d'un nouveau message ou l'envoi d'une réponse automatique en cas d'absence. Chaque compte Gmail dispose d'une seule adresse d'envoi par défaut. Par conséquent, la seule valeur valide que les clients peuvent écrire dans ce champ est true. Si vous remplacez false par true pour une adresse, ce champ deviendra false pour l'autre adresse par défaut précédente.

treatAsAlias

boolean

Indique si Gmail doit traiter cette adresse comme un alias pour l'adresse e-mail principale de l'utilisateur. Ce paramètre ne s'applique qu'aux alias de "de" personnalisés.

smtpMsa

object (SmtpMsa)

Service SMTP facultatif qui sera utilisé comme relais sortant pour les e-mails envoyés à l'aide de cet alias. Si ce champ est vide, les e-mails sortants sont envoyés directement depuis les serveurs de Gmail au service SMTP de destination. Ce paramètre ne s'applique qu'aux alias de "de" personnalisés.

verificationStatus

enum (VerificationStatus)

Indique si cette adresse a été validée pour être utilisée comme alias d'envoi. Lecture seule. Ce paramètre ne s'applique qu'aux alias de "de" personnalisés.

SmtpMsa

Configuration pour la communication avec un service SMTP.

Représentation JSON
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Champs
host

string

Nom d'hôte du service SMTP. Obligatoire.

port

integer

Port du service SMTP. Obligatoire.

username

string

Nom d'utilisateur à utiliser pour l'authentification avec le service SMTP. Il s'agit d'un champ en écriture seule qui peut être spécifié dans les requêtes de création ou de mise à jour des paramètres SendAs. Il n'est jamais renseigné dans les réponses.

password

string

Mot de passe à utiliser pour l'authentification avec le service SMTP. Il s'agit d'un champ en écriture seule qui peut être spécifié dans les requêtes de création ou de mise à jour des paramètres SendAs. Il n'est jamais renseigné dans les réponses.

securityMode

enum (SecurityMode)

Protocole utilisé pour sécuriser la communication avec le service SMTP. Obligatoire.

SecurityMode

Protocole pouvant être utilisé pour sécuriser la communication avec le service SMTP.

Enums
securityModeUnspecified Mode de sécurité non spécifié.
none La communication avec le service SMTP distant n'est pas sécurisée. Nécessite le port 25.
ssl La communication avec le service SMTP distant est sécurisée à l'aide de SSL.
starttls La communication avec le service SMTP distant est sécurisée à l'aide de STARTTLS.

VerificationStatus

Indique si la propriété d'une adresse a été validée pour son utilisation en tant qu'alias d'envoi.

Enums
verificationStatusUnspecified État de validation non spécifié.
accepted L'adresse est prête à être utilisée comme alias d'envoi.
pending L'adresse est en attente de validation par le propriétaire.

Méthodes

create

Crée un alias d'expéditeur personnalisé.

delete

Supprime l'alias d'envoi spécifié.

get

Récupère l'alias d'envoi spécifié.

list

Liste les alias d'envoi pour le compte spécifié.

patch

Appliquez un correctif à l'alias d'envoi spécifié.

update

Met à jour un alias d'envoi.

verify

Envoie un e-mail de validation à l'adresse de l'alias d'envoi spécifié.