4D Doc Center : SMTP

4D Internet Commands v14

SMTP_Comments


SMTP_Comments ( smtp_ID ; msgCommentaires {; supprimerOption} ) -> Résultat

Paramètre	Type	Description
smtp_ID	Entier long	Référence de message
msgCommentaires	Texte	Texte du commentaire
supprimerOption	Entier	0 = Remplacer sauf si msgCommentaires vide, 1 = Remplacer, 2 = Supprimer
Résultat	Entier	Code d'erreur

Description

La commande SMTP_Comments permet d'ajouter des commentaires au message sans modifier le corps du message. Les commentaires n'apparaissent que dans la zone d'en-tête. De nombreux logiciels de messagerie n'affichent pas l'intégralité des en-têtes du message.

smtp_ID contient l'identifiant d'un message électronique créé avec la commande SMTP_New.

Le paramètre msgCommentaires contient le texte que vous souhaitez placer en tant que commentaire dans l'en-tête du message.

Attention : Le texte ne doit pas contenir de retours à la ligne (code ASCII=10). Un retour à la ligne désigne la fin de la section d'en-tête et le début du corps du texte. Les en-têtes suivants risquent alors d'être considérés comme le corps du texte et de ne pas être correctement reconnus par le logiciel du serveur ou du client. Pour plus d'informations sur les zones d'en-tête, veuillez consulter la RFC 822.

Le paramètre optionnel supprimerOption vous permet de préciser s'il faut conserver ou supprimer l'en-tête "Commentaires" éventuellement existant :

Si vous passez 0 (zéro), le contenu du paramètre msgCommentaires remplace dans la zone d'en-tête tout texte éventuellement présent, sauf si vous passez une chaîne vide dans msgCommentaires, auquel cas l'en-tête "Commentaires" existant et son contenu sont conservés.
Si vous passez 1, le contenu du paramètre msgCommentaires remplace dans la zone d'en-tête tout texte éventuellement présent. Dans ce cas, si vous passez une chaîne vide dans msgCommentaires, l'en-tête "Commentaires" existant est supprimé.
Si vous passez 2, l'en-tête "Commentaires" est supprimé du message.
Si supprimerOption est omis, par défaut la valeur 0 est utilisée.

Exemple

Reportez-vous à l'exemple de la commande SMTP_Body.