SMTPTransporter

La classe SMTPTransporter vous permet de configurer des connexions SMTP et d'envoyer des emails par le biais d'objets SMTP transporter.

Objet SMTP Transporter

Les objets SMTP Transporter sont instanciés avec la commande SMTP New transporter. Leurs propriétés et fonctions sont les suivantes :

4D.SMTPTransporter.new()

4D.SMTPTransporter.new*( server : Object ) : 4D.SMTPTransporter

Paramètres	Type		Description
server	Object	->	Informations sur le serveur de messagerie
Résultat	4D.SMTPTransporter	<-	Objet SMTP Transporter

Description

La fonction 4D.SMTPTransporter.new() crée et retourne un nouvel objet de type 4D.SMTPTransporter. Elle est identique à la commande SMTP New transporter (raccourci).

Pour une description des codes de statut SMTP, veuillez vous reporter à cette page.

Exemple

 var $pw : Text
 var $options : Object
 var $transporter : 4D.SMTPTransporter
 $options:=New object

 $pw:=Request("Please enter your password:")
 $options.host:="smtp.gmail.com"

 $options.user:="test@gmail.com"
 $options.password:=$pw

 $transporter:=SMTP New transporter($options)

 $status:=$transporter.checkConnection()
 If($status.success=True)
    ALERT("SMTP connection check successful!")
 Else
    ALERT("Error # "+String($status.status)+", "+$status.statusText)
 End if

.keepAlive

Historique

Release	Modifications
17 R4	Ajout

.keepAlive* : Boolean

Description

La propriété .keepAlive contient True si la connexion SMTP doit rester active jusqu'à la destruction de l'objet transporter, et False sinon. Par défaut, si la propriété keepAlive n'a pas été définie dans l'objet server (qui permet de créer l'objet transporter via la commande SMTP New transporter), elle est mise à True.

La connexion SMTP est automatiquement fermée :

• lorsque l'objet transporter est détruit si la propriété .keepAlive est mise à vrai,
• après chaque fonction .send( ) exécutée si la propriété .keepAlive est mise à faux.

.send()

Historique

Release	Modifications
17 R5	Prise en charge des contenus Mime
17 R4	Ajout

.send*( mail : Object ) : Object

Paramètres	Type		Description
mail	Object	->	Email à envoyer
Résultat	Object	<-	Statut SMTP

Description

La fonction .send() envoie l'objet mail vers le serveur SMTP défini dans l'objet transporter et retourne un objet statut.

L'objet transporter doit avoir déjà été créé à l'aide de la commande SMTP New transporter.

La fonction établit la connexion SMTP si cette dernière n'est pas déjà active. Si la propriété .keepAlive de l'objet transporter est à false, la connexion SMTP est automatiquement fermée après l'exécution de la commande .send(). Pour plus d'informations, veuillez vous référer à la description de la commande SMTP New transporter.

Dans mail, passez un objet Email valide à envoyer. Les propriétés origine (la provenance de l'Email) et destination (un ou plusieurs destinataires) de l'Email doivent être incluses, les autres propriétés sont optionnelles.

Objet retourné

La fonction retourne un objet décrivant le statut SMTP de l"opération. Cet objet peut avoir les propriétés suivantes :

Propriété	Type	Description
success	boolean	Vrai si l'envoi a été effectué avec succès, sinon Faux
status	number	Code du statut retourné par le serveur SMTP (0 si problème non lié au traitement de l'email)
statusText	text	Message de statut retourné par le serveur SMTP

En cas de problème non lié au traitement SMTP (par exemple une propriété obligatoire qui est manquante dans l'objet mail), 4D génère une erreur que vous pouvez intercepter à l'aide d'une méthode installée via la commande ON ERR CALL. Utilisez la commande Last errors pour obtenir des informations sur l'erreur.

Dans ce cas, l'objet erreur qui en résulte contient les valeurs suivantes :

Propriété	Valeur
success	False
status	0
statusText	"Failed to send email"