SMTP_Subject

4D v20

SMTP_Subject


SMTP_Subject ( smtp_ID ; msgObjet {; supprimerOption} ) -> Résultat

Paramètre	Type	Description
smtp_ID	Entier long	Référence de message
msgObjet	Texte	Objet du message (UTF-8 par défaut)
supprimerOption	Entier	0 = Remplacer sauf si msgObjet vide, 1 = Remplacer, 2 = Supprimer
Résultat	Entier	Code d'erreur

Description

La commande SMTP_Subject ajoute l'en-tête "Objet" (Subject) au message référencé par smtp_ID. Si un objet avait déjà été défini par une précédente commande SMTP_Subject, le nouvel objet écrase le précédent.

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

msgObjet contient un texte concis décrivant le sujet traité en détail dans le corps du message.

Notes :

Par défaut, l'en-tête "Objet" du message est encodé en UTF-8, ce qui garantit que les caractères envoyés seront correctement interprétés par la quasi totalité des clients de messagerie. Si vous souhaitez utiliser un jeu de caractères spécifique, reportez-vous aux commandes SMTP_SetPrefs et SMTP_Charset.
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 "Objet" éventuellement existant :

Si vous passez 0 (zéro), le contenu du paramètre msgObjet remplace dans la zone d'en-tête tout texte éventuellement présent, sauf si vous passez une chaîne vide dans msgObjet, auquel cas l'en-tête "Objet" existant et son contenu sont conservés.
Si vous passez 1, le contenu du paramètre msgObjet remplace dans la zone d'en-tête tout texte éventuellement présent. Dans ce cas, si vous passez une chaîne vide dans msgObjet, l'en-tête "Objet" existant est supprimé.
Si vous passez 2, l'en-tête "Objet" 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.

Voir aussi

SMTP_Charset
SMTP_New
SMTP_SetPrefs