REST Resource: users.settings.sendAs

Ressource: SendAs

Paramètres associés à un alias d'adresse d'expédition, qui peut être l'adresse de connexion principale associée au compte ou une adresse d'expédition 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 apparaît dans l'en-tête "De" des e-mails envoyés à l'aide de cet alias. Cette option est en lecture seule pour toutes les opérations, à l'exception de "create".

displayName

string

Nom qui s'affiche dans l'en-tête "De" des messages envoyés à l'aide de cet alias. Pour les adresses d'expéditeur personnalisées, si ce champ 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 fonctionnalité permettant aux utilisateurs de mettre à jour leur format de nom, les demandes de mise à jour de ce champ pour la connexion principale échoueront.

replyToAddress

string

Adresse e-mail facultative incluse dans l'en-tête "Reply-To" des messages envoyés avec 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 composés de cet alias dans l'interface utilisateur Web de Gmail. Cette signature est ajoutée aux nouveaux e-mails uniquement.

isPrimary

boolean

Indique s'il s'agit de l'adresse principale utilisée pour se connecter au compte. Chaque compte Gmail ne possède qu'une seule adresse principale et 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 par défaut dans le champ "De" (par exemple, lors de la rédaction d'un nouveau message ou de l'envoi d'une réponse automatique). Chaque compte Gmail possède exactement une adresse d'envoi par défaut. La seule valeur juridique que les clients peuvent saisir dans ce champ est donc true. Si vous remplacez false par true pour une adresse, ce champ deviendra false pour l'ancienne adresse par défaut.

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 d'expéditeur personnalisés.

smtpMsa

object (SmtpMsa)

Service SMTP facultatif qui sera utilisé comme relais sortant pour les messages envoyés à l'aide de 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éditeur personnalisés.

verificationStatus

enum (VerificationStatus)

Indique si cette adresse a été validée pour une utilisation en tant qu'alias d'envoi. Lecture seule. Ce paramètre ne s'applique qu'aux alias d'expéditeur personnalisés.

Message d'erreur

Configuration de 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 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 des paramètres SendAs. Il n'est jamais renseigné dans les réponses.

password

string

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 des paramètres SendAs. Il n'est jamais renseigné dans les réponses.

securityMode

enum (SecurityMode)

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

Mode de sécurité

Protocole permettant de 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 via le protocole SSL.
starttls La communication avec le service SMTP distant est sécurisée via STARTTLS.

État de la validation

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'envoi personnalisé en tant qu'expéditeur.

delete

Supprime l'alias "send-as" spécifié.

get

Récupère l'alias "send-as" spécifié.

list

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

patch

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

update

Met à jour un alias d'envoi.

verify

Envoyer un e-mail de validation à l'adresse d'envoi spécifiée en tant qu'alias