Guide pratique pour configurer un port d’envoi SMTP
Vous pouvez configurer un port d'envoi SMTP par programme ou à l'aide de la console Administration de BizTalk Server.
Configuration d'un port d'envoi SMTP par programme
L'adaptateur SMTP stocke ses informations de configuration dans la base de données de gestion BizTalk (également appelée « base de données de configuration »). Elles sont stockées dans un jeu de propriétés XML personnalisé. Lors de l'initialisation et de l'exécution de l'adaptateur SMTP, le serveur transmet la configuration à l'adaptateur comme suit :
Pour le gestionnaire d’envoi SMTP, les informations de configuration passent à l’adaptateur en appelant la méthode Load de l’interface IPersistPropertyBag .
Pour les adaptateurs d'envoi SMTP, les informations de configuration sont transmises à l'adaptateur sous la forme d'un jeu de propriétés dans un contexte de message. L'espace de noms SMTP regroupe ces propriétés.
Le modèle objet de l'Explorateur BizTalk expose l'interface de configuration d'adaptateur ITransportInfo pour les ports d'envoi contenant la propriété de lecture/écriture TransportTypeData. Cette propriété accepte le jeu de propriétés de configuration du port d'envoi SMTP sous la forme d'une chaîne XML composée d'une paire nom/valeur. Notez que pour définir cette propriété dans le modèle objet BizTalk Explorer, elle doit d’abord être définie sur la propriété Address de l’interface ITransportInfo.
La définition de la propriété TransportTypeData de l’interface ITransportInfo n’est pas nécessaire. Si elle n'est pas définie, l'adaptateur SMTP utilise les valeurs par défaut pour le gestionnaire d'envoi SMTP. Les propriétés spécifiques au port d'envoi SMTP sont définies dans le schéma de propriété de l'adaptateur d'envoi SMTP bts_smtp_properties.xsd.
Si les propriétés qui dupliquent la configuration du gestionnaire d'envoi ne sont pas définies, les propriétés de configuration pour le gestionnaire sont utilisées. Si les propriétés requises ne sont pas définies, les valeurs par défaut sont utilisées. Si les valeurs par défaut ne sont pas définies, le gestionnaire d'envoi SMTP consigne une erreur dans le journal des événements et déplace le message vers l'adaptateur de secours.
Vous pouvez définir ces propriétés par programme dans un contexte de message. Vous pouvez définir ces propriétés dans une planification d'orchestration BizTalk ou dans un composant de pipeline personnalisé. Les règles suivantes s'appliquent dans le cadre de l'utilisation de ces propriétés :
Si la propriété est définie dans une orchestration ou le composant de pipeline personnalisé dans un pipeline de réception, alors :
Si le message est envoyé à un port d'envoi statique, la valeur de la propriété est remplacée par la valeur configurée pour ce port d'envoi.
Si le message est envoyé à un port d'envoi dynamique, la valeur de la propriété n'est pas remplacée.
Si la propriété est définie dans un composant de pipeline personnalisé dans un pipeline d'envoi, alors :
- La valeur n'est pas remplacée, que le message soit envoyé à un port d'envoi statique ou dynamique.
Le tableau suivant répertorie les propriétés de configuration que vous pouvez définir dans le modèle objet de l'Explorateur BizTalk pour l'emplacement d'envoi SMTP.
Nom de la propriété | Type | Description | Restrictions | Commentaires |
---|---|---|---|---|
SMTPHost | xs:string | Serveur SMTP utilisé pour l'envoi des messages. | Longueur maximale : 256 | Valeur par défaut : Vide. La valeur par défaut indique que le port d'envoi SMTP utilisera les valeurs de configuration pour le gestionnaire. |
From | xs:string | Adresse de messagerie que le port d’envoi SMTP place sur l’en-tête SMTP From . | Longueur maximale : 256 | Valeur par défaut : Vide. La valeur par défaut indique que le port d'envoi SMTP utilisera les valeurs de configuration pour le gestionnaire. |
CC | xs:string | Adresse de messagerie vers laquelle une copie du message sera envoyée. | Longueur maximale : 1024 | Valeur par défaut : Vide Vous pouvez répertorier différentes adresses de messagerie. |
Subject | xs:string | En-tête objet pour les messages. | Longueur minimale : 0 Longueur maximale : 256 |
Valeur par défaut : %MessageID%. |
SMTPAuthenticate | xs:int | Type d'authentification à utiliser. | None | Valeurs valides : - 0 - Aucune authentification - 1- Authentification de base - 2 - Compte de processus (NTLM) La valeur par défaut indique que le port d'envoi SMTP utilisera les valeurs de configuration pour le gestionnaire. Pour appliquer la valeur par défaut, omettez cette propriété du jeu de propriétés lors de la configuration de la propriété TransportTypeData. |
UserName | xs:string | Nom d'utilisateur utilisé pour l'authentification sur le serveur SMTP. | Longueur minimale : 0 Longueur maximale : 256 |
Valeur par défaut : Vide Nécessite une valeur si SMTPAuthenticate est égal à 1 (authentification de base). |
Mot de passe | xs:string | Mot de passe de l'utilisateur pour l'authentification sur le serveur SMTP. | Longueur minimale : 0 Longueur maximale : 256 |
Valeur par défaut : Vide Nécessite une valeur si SMTPAuthenticate est égal à 1 (authentification de base). |
ReadReceipt | xs:boolean | Demande une confirmation de lecture pour les messages à partir de ce port d'envoi. | None | Valeur par défaut : False |
DeliveryReceipt | xs:boolean | Demande un accusé de réception pour les messages à partir de ce port d'envoi. | None | Valeur par défaut : False |
EmailBodyText | xs:string | Indiquer le texte à utiliser pour le corps du message électronique à envoyer. | Longueur maximale : 64 Ko | Valeur par défaut : Vide |
EmailBodyTextCharset | xs:string | Spécifiez le jeu de caractères à utiliser pour l’encodage du corps du message électronique envoyé lorsque l’option EmailBodyText est utilisée. L’adaptateur SMTP convertit le EmailBodyText en jeu de caractères spécifié par EmailBodyTextCharset. | None | Valeur par défaut : Aucun. Vous devez définir la valeur de manière explicite, par exemple, sur UTF-8. Si aucune valeur n'est définie, le message d'erreur indiqué à la fin de cette rubrique peut s'afficher. |
EmailBodyFile | xs:string | Indique que le corps du message électronique à envoyer correspond au contenu d'un fichier, et précise le chemin d'accès à ce dernier. Ce chemin doit être accessible à l’hôte pour l’adaptateur SMTP au moment de l’exécution. | Longueur maximale du chemin d’accès : 256 caractères | Valeur par défaut : Vide |
EmailBodyFileCharset | xs:string | Spécifiez le jeu de caractères à utiliser pour encoder le corps du message électronique envoyé si la propriété EmailBodyFile est définie. L'adaptateur SMTP n'effectue aucune conversion du fichier ; celui-ci doit être déjà codé dans ce jeu de caractères. Si le fichier inclut une marque d'ordre de tri, l'adaptateur SMTP la supprime. | None | Valeur par défaut : UTF-8 (65001) |
Pièces jointes | xs:string | Indique qu'un ou plusieurs fichiers sont joints au message électronique, et précise leur chemin d'accès. L'hôte de l'adaptateur SMTP doit pouvoir y accéder au moment de l'exécution. | Longueur maximale du chemin d’accès : 256 caractères | Valeur par défaut : Vide |
MessagePartsAttachments | xs:int | Indique la méthode utilisée pour joindre les parties d'un message BizTalk à un message électronique | None | Valeurs valides : - 0 - Aucune partie de message BizTalk ne sera utilisée comme pièces jointes. - 1 - La partie corps du message BizTalk est envoyée sous forme de pièce jointe. Dans ce cas, les propriétés EmailBodyFile ou EmailBodyText doivent être spécifiées. Si aucune de ces propriétés n'est spécifiée, le corps du message BizTalk est envoyé en tant que corps du message électronique, et non comme pièce jointe. - 2 - Toutes les parties sont envoyées en tant que pièces jointes. Toutefois, si EmailBodyText ou EmailBodyFile ne sont pas spécifiés, la partie corps du message BizTalk est envoyée en tant que corps du courrier électronique et d’autres parties sont envoyées en tant que pièces jointes. Valeur par défaut : 0 |
ReplyBy | xs:dateTime | Remplit le champ d’en-tête Répondre par dans le message sortant avec la valeur spécifiée. | Cette propriété ne peut pas être définie dans la page de propriété du port d'envoi. Cette propriété peut être définie à partir d'un pipeline ou d'une orchestration. | Valeur par défaut : Vide |
Le code suivant illustre le format de la chaîne XML que vous devez utiliser pour définir ces propriétés :
<CustomProps>
<DeliveryReceipt vt="11">-1</DeliveryReceipt
<SMTPHost vt="8">sfdsadf</SMTPHost>
<Subject vt="8">Some subject</Subject>
<From vt="8">username@domain.com</From>
<SMTPAuthenticate vt="19">2</SMTPAuthenticate>
<ReadReceipt vt="11">-1</ReadReceipt>
</CustomProps>
Configuration d'un port d'envoi SMTP à l'aide de la console Administration de BizTalk Server
Vous pouvez définir les variables de l'adaptateur du port d'envoi SMTP dans la console Administration de BizTalk. Si les propriétés ne sont pas définies pour le port d'envoi, les valeurs par défaut du gestionnaire d'envoi définies dans la console Administration de BizTalk Server sont utilisées.
La procédure suivante permet de configurer le port d'envoi SMTP à l'aide de la console Administration de BizTalk Server.
Pour configurer les variables pour un port d'envoi SMTP
Dans la console Administration de BizTalk Server, créez un port d'envoi ou double-cliquez sur un port d'envoi existant pour le modifier. Pour plus d’informations, consultez Création d’un port d’envoi. Configurez toutes les options de port d’envoi et spécifiez SMTP pour l’option Type dans la section Transport de l’onglet Général .
Sous l’onglet Général , dans la section Transport , en regard de Type, cliquez sur Configurer.
Dans la boîte de dialogue Propriétés du transport SMTP , sous l’onglet Général , procédez comme suit :
Propriété Pour To Obligatoire. Indiquer l'adresse électronique à laquelle envoyer les messages.
Vous pouvez entrer plusieurs adresses.
Longueur maximale : 256
Pour plus d’informations sur cette propriété, consultez Restrictions sur la propriété SMTP To.CC Indiquer l'adresse électronique à laquelle envoyer une copie carbone du message.
Vous pouvez entrer plusieurs adresses.
Longueur maximale : 1024Subject Indiquer l'en-tête objet du message.
Longueur minimale : 0
Longueur maximale : 256Notification Préciser le type d'accusé de notification. Vous pouvez sélectionner l'un ou les deux types d'accusés. Les types d'accusés de notification sont :
- Confirmation de lecture. un message de confirmation est envoyé dès que le message est lu.
- Accusé de réception. Le message électronique de confirmation est envoyé lors de la remise du message.Dans la boîte de dialogue Propriétés du transport SMTP , sous l’onglet Composer , procédez comme suit :
Propriété Pour Corps du message BizTalk Indiquer qu'il faut utiliser le corps du message BizTalk pour le corps du message électronique à envoyer. Texte Indiquer le texte à utiliser pour le corps du message électronique à envoyer. Une fois l’option Texte sélectionnée, vous pouvez entrer le texte du corps de l’e-mail dans la zone de texte.
Longueur maximale : 64 KoJeu de caractères du texte - Spécifiez le jeu de caractères à utiliser pour l’encodage du corps du message électronique envoyé. Cette option n’est disponible que si l’option Texte est sélectionnée.
- Valeur par défaut : UTF-8 (65001)File Indiquer que le corps du message électronique à envoyer sera le contenu d'un fichier, et préciser le chemin d'accès à ce dernier. Une fois l’option Fichier sélectionnée, vous pouvez cliquer sur le bouton Points de suspension (...) pour accéder au fichier.
Longueur maximale du chemin d’accès : 256 caractères Remarque : Il est recommandé de spécifier un chemin d’accès sur un partage de fichiers accessible à partir de tous les serveurs BizTalk du groupe BizTalk Server à utiliser en production.Jeu de caractères du fichier Indiquer le jeu de caractères de codage du fichier envoyé. Note: L’adaptateur SMTP n’applique pas l’encodage spécifié au fichier. Cette option sert uniquement à spécifier que le fichier en cours d'envoi est déjà codé.
Cette option est disponible uniquement si l’option Fichier est sélectionnée.
Valeur par défaut : UTF-8 (65001)Dans la boîte de dialogue Propriétés du transport SMTP , sous l’onglet Pièces jointes , procédez comme suit :
Propriété Pour Renommer les parties de message BizTalk Indiquer la méthode utilisée pour joindre les parties de message BizTalk à un message électronique.
Options :
- Ne pas attacher de pièces
- Attacher uniquement une partie de corps
- Attacher toutes les parties
Valeur par défaut : n’attachez pas de parties.Ajouter Indiquer un ou plusieurs fichiers à joindre à un courrier électronique. Après avoir cliqué sur Ajouter , vous pouvez rechercher pour sélectionner un fichier et l’ajouter à la liste des fichiers à joindre.
Longueur maximale du chemin : 256 caractères Remarque : Il est recommandé de spécifier un chemin d’accès sur un partage de fichiers accessible à partir de tous les serveurs BizTalk du groupe BizTalk Server à utiliser en production.Remove Supprimer le fichier sélectionné de la liste des fichiers à joindre à un message électronique. Dans la boîte de dialogue Propriétés du transport SMTP , sous l’onglet Remplacement du gestionnaire , procédez comme suit :
Propriété Pour Nom du serveur SMTP Indiquer le nom du serveur SMTP à utiliser pour l'envoi des messages.
Longueur maximale : 256 Remarque : l’URI d’un port d’envoi ou d’un emplacement de réception ne peut pas dépasser 256 caractères.De (adresse de messagerie) Spécifiez l’adresse de messagerie à placer dans l’en-tête SMTP From .
Longueur maximale : 256Type d’authentification Indique le type d'authentification à utiliser avec le serveur SMTP.
Options :
- (Par défaut)
- Aucune authentification
- Authentification de base
- Compte de processus (NTLM)
La valeur par défaut indique que le port d’envoi SMTP utilise les valeurs de configuration spécifiées dans le gestionnaire d’envoi.Nom d'utilisateur Indiquer le nom d'utilisateur nécessaire à l'authentification sur le serveur SMTP.
Cette propriété nécessite une valeur si le type d’authentification est l’authentification de base.
Longueur minimale : 0
Longueur maximale : 256Mot de passe Indiquer le mot de passe nécessaire à l'authentification sur le serveur SMTP.
Cette propriété nécessite une valeur si le type d’authentification est l’authentification de base.
Longueur minimale : 0
Longueur maximale : 256Cliquez sur OK , puis sur OK à nouveau pour enregistrer les paramètres.