MailCapture

MailCapture est un module de MaarchCapture permettant de récupérer les courriels d'un dossier de votre boite mail via le protocole IMAP.

Paramétrage général du module

Depuis le fichier de paramétrage général : ./config/Capture.xml.

<step function="CaptureMails" module="MailCapture" name="CAPTURE_MAIL_1">
    <input name="account">account_1</input>
    <input name="Action">none</input>
    <input name="configFile">MailCapture_standard_sample.xml</input>
    <input name="folder">maarch/purge</input>
    <input name="attachmentsOutputDir"></input>
    <input name="addHeaderInMailContent">false</input>
    <input name="folderError">incidents</input>
</step>

La déclaration du module comporte les attributs suivants :

• account identifiant du compte utilisé dans le fichier configFile du module MailCapture.
• action prend none, move ou delete. none aucune action, move permet de déplacer le courriel traité dans un autre répertoire, delete permet de le supprimer du répertoire d’entrée après son traitement.
• configFile nom du fichier de configuration définissant les règles d’accès à la boite mail via IMAP ainsi que les métadonnées récupérées des courriels. Le nom du fichier défini doit se trouver dans le répertoire ./modules/MailCapture/.
• folder utile uniquement si l’action move est déclarée. Déplace le courriel dans le répertoire indiqué ici.
• attachmentsOutputDir déplace les pièces jointes des courriels capturés dans ce répertoire.
• addHeaderInMailContent flag déterminant si l’on ajoute un entête aux courriels capturés (dans le fichier HTML). Peut prendre comme valeur true ou false. Si activé, on rajoute dans le fichier HTML du mail les entêtes reçu le et envoyé par.
• folderError dossier du compte IMAP vers lequel on déplace les courriels en cas d’erreur de capture.

Paramétrage particulier de la boite mail

Depuis le fichier de paramétrage de la boite mail à capturer : ./modules/MailCapture/MailCapture_standard_sample.xml.

<?xml version="1.0" encoding="UTF-8"?>
<MailCapture>
    <formatters>
        <formatter name="date" script="scripts/formatters.php" func="format_mail_date"/>
    </formatters>
    <accounts>
        <account name="account_1" >
            <mailbox>{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX</mailbox>
            <username>testmail@gmail.com</username>
            <password>********</password>
        </account>
    </accounts>
    <messagerules>
        <messagerule name="from_maarch" info="fromaddress" action="delete">false</messagerule>
    </messagerules>
    <messageoutputs >
        <messageoutput name="doc_date" info="date" formatter="date"/>
        <messageoutput name="type_id">108</messageoutput>
        <messageoutput name="destination">COU</messageoutput>
        <messageoutput name="subject" info="subject" />
        <messageoutput name="fromaddress" info="fromaddress"/>
        <messageoutput name="frompersonal" info="from[0]/personal" />
        <messageoutput name="toaddress" info="toaddress" />
        <messageoutput name="xpriority" info="xpriority" />
        <messageoutput name="message_id" info="message_id" />
        <messageoutput name="ccaddress" info="ccaddress" />
    </messageoutputs>
    <attachmentrules>
        <attachmentrule name="extFilter" info="extension" op="notin">pdf</attachmentrule>
        <attachmentrule name="mimetypeFilter" info="mimetype" op="notin">application/pdf</attachmentrule>
    </attachmentrules>
    <attachmentoutputs mode="attachment">
        <attachmentoutput name="filename" info="dparameters[filename]"/>
        <attachmentoutput name="description" info="description"/>
    </attachmentoutputs>
</MailCapture>

La déclaration de la boite mail à capturer comporte les attributs suivants :

• account name identifiant du compte utilisé dans le fichier Capture.xml.
• mailbox l’adresse du serveur de messagerie, attention à bien respecter la syntaxe {adresseserver:port/modeacces}repertoire.
• username compte de la boite mail à capturer.
• password mot de passe du compte de la boite mail à capturer
• messagerules règle de traitement du courriel.
• messageoutputs paramétrage des métadonnées capturées dans le courriel. Utile pour le versement dans MaarchCourrier par la suite. Ces métadonnées sont stockées dans le fichier général de traitement du batch.
• attachmentrules permet de filtrer les pièces jointes capturées selon le critère défini. Dans l’exemple on filtre à la fois sur l’extension du fichier et son type mime. Dans l’exemple on n’autorise que les pdf à être capturés. Pour ajouter d’autres formats, il faut ajouter un espace entre chaque format, ex : pdf jpeg pour les extensions application/pdf application/msword pour les types mimes.
• attachmentoutputs permet de préparer le format de sortie des fichiers correspondants aux pièces jointes des courriels.