Ressource: SendAs
Paramètres associés à un alias d'envoi en tant que, qui peut être l'adresse de connexion principale associée au compte ou une adresse d'expéditeur personnalisée. Les alias "Envoyer des e-mails en tant que" correspondent à la fonctionnalité Envoyer des e-mails en tant que dans l'interface Web.
Représentation JSON |
---|
{ "sendAsEmail": string, "displayName": string, "replyToAddress": string, "signature": string, "isPrimary": boolean, "isDefault": boolean, "treatAsAlias": boolean, "smtpMsa": { object ( |
Champs | |
---|---|
sendAsEmail |
L'adresse e-mail qui apparaît dans l'en-tête "De" des e-mails envoyés avec cet alias. Il est en lecture seule pour toutes les opérations, à l'exception de la création. |
displayName |
Nom qui apparaît dans l'en-tête "De" des e-mails envoyés avec cet alias. Pour les adresses d'expéditeur personnalisées, lorsque ce champ n'est pas renseigné, Gmail affichera le nom de l'adresse principale associée au compte dans l'en-tête "De". Si l'administrateur a désactivé la possibilité pour les utilisateurs de mettre à jour le format du nom, les demandes de mise à jour de ce champ pour la connexion principale échoueront sans notification. |
replyToAddress |
Adresse e-mail facultative incluse dans l'en-tête "Répondre à" pour les e-mails envoyés avec cet alias. S'il est vide, Gmail ne génère pas d'en-tête "Répondre à". |
signature |
Signature HTML facultative incluse dans les messages composés avec cet alias dans l'interface utilisateur Web de Gmail. Cette signature n'est ajoutée qu'aux nouveaux e-mails. |
isPrimary |
Indique si cette adresse est l'adresse principale utilisée pour se connecter au compte. Chaque compte Gmail est associé à une seule adresse principale et ne peut pas être supprimé de la collection des alias "Envoyer en tant que". Ce champ est en lecture seule. |
isDefault |
Ce paramètre indique si cette adresse doit être sélectionnée comme adresse par défaut du champ "De" (par exemple, lorsque vous rédigez un nouveau message ou envoyez un message automatique d'absence). Chaque compte Gmail possède exactement une adresse "Envoyer en tant que" par défaut. La seule valeur légale que les clients peuvent écrire dans ce champ est donc |
treatAsAlias |
Indique si Gmail doit traiter cette adresse comme un alias de l'adresse e-mail principale de l'utilisateur. Ce paramètre ne s'applique qu'aux alias d'expéditeurs personnalisés. |
smtpMsa |
Service SMTP facultatif utilisé comme relais sortant pour les e-mails envoyés avec cet alias. Si ce champ est vide, les messages sortants sont envoyés directement des serveurs Gmail au service SMTP de destination. Ce paramètre ne s'applique qu'aux alias d'expéditeurs personnalisés. |
verificationStatus |
Indique si cette adresse a été validée pour être utilisée en tant qu'alias d'envoi. Lecture seule. Ce paramètre ne s'applique qu'aux alias d'expéditeurs personnalisés. |
SmtpMsa
Configuration de la communication avec un service SMTP.
Représentation JSON |
---|
{
"host": string,
"port": integer,
"username": string,
"password": string,
"securityMode": enum ( |
Champs | |
---|---|
host |
Nom d'hôte du service SMTP. Obligatoire. |
port |
Port du service SMTP. Obligatoire. |
username |
Nom d'utilisateur qui sera utilisé pour l'authentification auprès du service SMTP. Ce champ en écriture seule peut être spécifié dans les requêtes de création ou de mise à jour de paramètres SendAs. Il n'est jamais renseigné dans les réponses. |
password |
Mot de passe qui sera utilisé pour l'authentification auprès du service SMTP. Ce champ en écriture seule peut être spécifié dans les requêtes de création ou de mise à jour de paramètres SendAs. Il n'est jamais renseigné dans les réponses. |
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 l'authentification STARTTLS. |
VerificationStatus
Indique si la propriété d'une adresse a été validée pour être utilisée comme 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 |
|
---|---|
|
Crée un alias d'envoi personnalisé. |
|
Supprime l'alias d'envoi spécifié. |
|
Récupère l'alias d'envoi spécifié. |
|
Liste les alias d'envoi en tant que pour le compte spécifié. |
|
Appliquer un correctif à l'alias d'envoi spécifié. |
|
Met à jour un alias d'envoi en tant que. |
|
Envoie un e-mail de validation à l'alias d'adresse e-mail d'envoi spécifié. |