send-mime

www.altova.com Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  Fonctions intégrées > /system/mail >

send-mime

Chemin complet : /system/mail/send-mime

 

Envoie un e-mail aux destinataires spécifiés, généralement l'administrateur.

 

Note : Avant d'utiliser cette fonction, veuillez vous assurer que les paramètres du serveur mail sont configuré (voir Configuration des paramètres de mail).

 

Cette fonction retourne une booléenne TRUE si l'exécution a réussi. Si l'exécution de la tâche échoue, le résultat dépend de la valeur du paramètre Abandonner sur erreur, comme suit :

 

Si le paramètre Abandonner sur erreur est TRUE (valeur par défaut), l'exécution de la tâche est abandonnée. Dans ce cas, vous pouvez toujours gérer les erreurs par le biais de blocs protégés (voir Gestion des erreurs d'étape).
Si le paramètre Abandonner sur erreur est FALSE, la fonction retourne FALSE.

 

Contrairement à la fonction send, le paramètre Corps du message de cette fonction attend une expression qui produit un flux, pas un string. Cela vous permet d'obtenir le corps du message (par exemple, en tant que HTML) depuis un stream.

 

Afin d'obtenir un contenu HTML pour le corps de message, il est fortement recommandé d'appeler une transformation StyleVision Server qui produit une sortie HTML en tant que MIME. En soi, FlowForce Server ne collecte pas d'images, feuilles de style ou autres ressources semblables référencées par des fichiers HTML dans un stream MIME auto-contenu.

 

Afin de pouvoir produire un corps de message HTML auto-contenu avec StyleVision Server, procéder comme suit :

 

1.Concevoir le corps HTML de l'e-mail dans Altova StyleVision. Le design peut contenir des images locales et des feuilles de style.
2.Déployer la transformation StyleVision vers FlowForce Server. Dans FlowForce, la transformation devient une fonction FlowForce intégrée qui peut ensuite être exécutée par StyleVision Server.
3.Créer une tâche qui appelle la transformation StyleVision Server ci-dessus, en s'assurant de choisir l'option GenerateHtmlOutputAsMime dans la page de configuration de la tâche.
4.Dans la page de configuration de la tâche, appeler les fonctions d'expression FlowForce Server pour récupérer le stream MIME généré et le faire passer dans le paramètre "Corps de message" de la fonction send-mime (voir "Exemple 1" ci-dessous).

 

Si des ressources externes référencées par le fichier HTML ne peuvent pas être intégrées dans le stream MIME, elles seront ajoutées en tant que pièces jointes dans le mail.

 

Une tâche d'exemple qui produit une sortie HTML en tant que stream MIME est illustrée ci-dessous. Pour un exemple étape par étape qui illustre comment déployer la transformation StyleVision vers FlowForce Server, voir Créer une tâche depuis une transformation StyleVision. Pour plus d'informations concernant l'intégration StyleVision Server, voir Intégration avec d'autres Serveurs Altova.

 

Pour créer le stream pour le corps du message directement dans FlowForce, vous pouvez aussi appeler des fonctions d'expression comme stream-open ou stream-from-string. De même, vous pouvez utiliser des fonctions d'expression MIME pour personnaliser les en-têtes de message de l'e-mail ou de la pièce jointe.

 

Pour éviter que l'e-mail soit envoyé dans le dossier "Poubelle" du destinataire, vous devriez constituer les en-têtes MIME de la manière autorisée par le serveur ou le programme de réception du message.

 

Paramètres

Name

Type

Description

De

string

Adresse e-mail à partir duquel le mail doit être envoyé, par exemple : flowforce@<hostname>.

À

string

Adresse e-mail du destinataire. Paramètre obligatoire.

Objet

string

Ligne d'objet du message. Paramètre obligatoire.

Corps de message

stream

Corps de texte du message, en tant qu'expression FlowForce qui retourne un type stream.

Pièce jointe

sequence of stream

La pièce jointe envoyée avec l'e-mail. Chaque pièce jointe doit être une expression FlowForce qui produit un stream. Appeler des fonctions d'expression stream pour créer des streams depuis des strings ou des fichiers. Appeler des fonctions d'expression MIME pour ajouter, modifier ou supprimer des en-têtes MIME.

Abandon sur erreur

boolean

Ce paramètre booléen détermine quelle doit être la valeur de retour de la fonction si la tâche échoue. Si Abandon sur erreur est FALSE, la fonction retournera également la valeur booléenne FALSE. Si Abandon sur erreur est TRUE, l'exécution de la tâche est abandonnée. La valeur par défaut est TRUE.

 

Exemples

Exemple 1 : La tâche illustrée ci-dessous invoque la fonction send-mime pour pouvoir envoyer un e-mail en format HTML.

 

La première étape d'exécution génère une sortie HTML en appelant une transformation StyleVision Server. Cette transformation a été conçue pour StyleVision puis déployée sur FlowForce Server, comme illustré dans la section Créer une tâche depuis une transformation StyleVision. Veuillez noter que la case à cocher GenerateHtmlOutputAsMime a été sélectionnée. Le résultat de la première étape d'exécution a été appelé "sortie" ("output") (nous allons nécessiter ce string dans une étape suivante et nous nous y référerons en saisissant "output" dans une expression).

 

La deuxième étape d'exécution appelle la fonction compute pour pouvoir calculer une expression FlowForce. Concrètement, l'expression nth(results(output), 0)prend le stream MIME avec l'index 0 (dans ce cas, OutHtml) depuis le résultat généré par l'étape précédente.

 

Enfin, la troisième étape d'exécution envoie le message e-mail. Le champ de saisie "Corps de message" contient aussi une expression FlowForce, qui, dans ce cas est le résultat calculé précédemment dans l'étape 2.

 

 

fs_send_mime_example1

Exemple 2: La tâche illustrée ci-dessous invoque la fonction send-mime pour pouvoir envoyer un e-mail en format HTML qui contient également une image en pièce jointe en format .png.

 

La première étape d'exécution prépare le corps du message. Pour une plus grande simplicité, le code HTML dans cet exemple a été saisi directement dans le champ de texte. La manière recommandée d'obtenir la sortie HTML est d'appeler une transformation StyleVision Server, comme illustré dans l'exemple précédent.

 

Le champ "Corps de message" contient une expression FlowForce. L'expression convertit le résultat de la première étape d'exécution (de type string) en un stream. La fonction stream-from-string a été appelée pour ce cas de figure. L'encodage et le type MIME désirés ont été passés en tant qu'arguments vers la fonction.

 

L'image en pièce jointe a été prise dans un chemin local, C:\sample.png.

fs_send_mime_example_cut

Veuillez noter que l'image ci-dessus a été réduite pour pouvoir être imprimée sur une seule page. Le champ "Attachment" contient l'expression suivante :

 

add-mime-header(stream-open('C:\sample.png', 'image/png'), 'Content-Disposition', 'attachment; filename=''sample.png')

 

L'expression ci-dessus fonctionne comme suit :

 

La fonction stream-open ouvre l'image en tant que stream.
La fonction add-mime-header ajoute l'en-tête "Content-Disposition" au stream. De cette manière, l'image en pièce jointe aura le nom intentionné ("sample.png").

© 2019 Altova GmbH