8. SendEmail

• URL:

« /RestApi/SendEmail»

• Méthode: POST
  
• Paramètres URL:
  • authToken [string] [Required]=le token d’authentification.
  • emailFrom [string] [Required]=l’adresse email de l’envoyeur. Ce paramètre doit avoir une de ces deux valeurs : “Org” ou “CurrentUser”. Si la valeur est “Org” alors l’email de l’envoyeur sera celui défini sur la page Organisation du menu Configuration. Si la valeur est “CurrentUser” alors l’email de l’envoyeur sera celui de l’utilisateur connecté (celui ayant permis de générer le token d’authentification.
  • emailTo [string] [Required]=la ou les adresses email des récipiendaires. S’il y a plusieurs valeurs, les séparer par des “;”.
  • emailCC [string] [Required]=la ou les adresses email à mettre en copie. S’il y a plusieurs valeurs, les séparer par des “;”.
  • emailBCC [string] [Required]=l’adresse email à mettre en copie cachée. S’il y a plusieurs valeurs, les séparer par des “;”.
  • emailReplyTo [string] [Required]=l’adresse email qui recevra l’email en cas de réponse.
  • emailSubject [string] [Required]=le sujet de l’email.
  • emailIsBodyHtml [booléen] [Required]= permet de définir si le corps de l’email est en texte ou en HTML. Valeurs possibles : true ou false.
  • enableSsl [booléen] [Required]=permet de spécifier si la connexion au serveur SMTP doit se faire en SSL ou pas. Valeurs possibles : true ou false.

• Paramètres du corps de message (Body):
  • = le corps de l’email en texte ou HTML (auquel cas emailIsBodyHtml doit être à true).

• Réponse de succès:
  • Status Code=200 (OK)
    
• Réponse d’erreur:
  • Status Code=400 (BadRequest) : au cas où il y a une erreur dans les données envoyées dans la requête
  • Status Code=400 (Email not sent) : au cas où il n’y a pas de serveur SMTP défini sur l’utilisateur (emailFrom = CurrentUser) ou sur l’organisation (emailFrom = Org)

Notes

• La méthode SendEmail() utilise la configuration SMTP définie sur la page Organisation (emailFrom = Org) ou pour l’utilisateur actif (emailFrom = CurrentUser) dans la zone de configuration. Si aucun serveur SMTP et informations d’identification ne sont définis, la méthode SendEmail() retournera un message 400 Email not sent.
• Lorsque la connexion SSL est activée (enableSsl = True), la méthode SendEmail() supporte les envois par SMTP en utilisant uniquement STARTTLS (habituellement sur le port 587). Il existe une autre méthode dénommée SMTP/SSL ou SMTP over SSL et qui utilise par défaut le port 465, cette méthode n’est pas supportée.