Module Unicaen Mail

Description

Le module unicaen/mail est en charge de l'envoi et du stockage des courriers électroniques.

Le module fournit un menu dans Administration > Mail permettant d'accéder au listing des mails et des actions liées à ceux-ci.

Description du fonctionnement

Les mails

Les entités Mail sont stockés en base avec les informations suivantes :

• destinataire (redirection ou pas)
• date d'envoi
• status
• sujet/corps
• mots clefs

MailService est en chage de faire l'envoi et l'enregistrement en base.

Exemple d'utilisation sans utilisation d'un template :

$mail = $this->getMailService()->sendMail('john.doe@aol.com', 'Reunion importante', 'Bonjour nous avons ...');

Exemple d'utilisation avec utilisation d'un template + entité liée :

$rendu = $this->getRenduService()->generateRenduByTemplateCode('MON TEMPLATE', ['VAR1' => $var1, 'VAR2' => $var2, ...]);
$mail = $this->getMailService()->sendMail('john.doe@aol.com', $rendu->getSujet(), $rendu->getCorps());
$mail->addMotsClefs(['MON_ENTITE', 'MON_TEMPLATE']);
$this->getMailService()->update($mail);

Aides de vue founies

'view_helpers' => [
    'invokables' => [
        'mail' => MailViewHelper::class,
        'mails' => MailsViewHelper::class,
    ],
],

$this->mail($monMail) : Affiche un mail généré avec la description à gauche et le texte généré à droite. $this->mails($monTableauDeMail) : Affiche une table avec une ligne par mail et founi les actions associées (affiachage, réenvoi, suppression).

Attention !!! l'aide mails peut recevoir un tableau permettant d'ajuster les droits des actions.

$options['droits'][
    'afficher' => Boolean, 
    'reenvoyer' => Boolean, 
    'supprimer' => Boolean
    ]

Configuration

La configuration locale à fournir est disponible dans [mail/config/unicaen-mail.local.php.dist]

<?php
/**
 * Configuration locale du module UnicaenMail.
 */
return [
    'unicaen-mail' => [

        /**
         * Classe de entité
         **/
        'mail_entity_class' => Mail::class,
        
        /**
         * Options concernant l'envoi de mail par l'application
         */
        'transport_options' => [
            'host' => 'smtp.XXXX.fr',
            'port' => 25,
        ],
        /**
         * Adresses des redirection si do_not_send est à true
         */
        'redirect_to' => ['john-doe@mail.fr', ],
        'do_not_send' => true,
        
        /**
         * Configuration de l'expéditeur
         */
        'subject_prefix' => '[Mon App]',
        'from_name' => 'Mon application',
        'from_email' => 'ne-pas-repondre@mail.fr'
    ],
];

Tables pour les données du modules

N.B. Le script permettant de créer les tables est fourni dans le fichier [mail/SQL/001_tables.sql]

unicaen_mail_mail : table stockant les mails

Privilèges associés au module

N.B. Le script permettant de créer les tables est fourni dans le fichier [mail/SQL/002_privileges.sql]

const MAIL_INDEX                            = 'mail-mail_index';
const MAIL_AFFICHER                         = 'mail-mail_afficher';
const MAIL_TEST                             = 'mail-mail_test';
const MAIL_REENVOI                          = 'mail-mail_reenvoi';
const MAIL_SUPPRIMER                        = 'mail-mail_supprimer';

Attention !!! Penser à donner les privilèges aux rôles adéquats.

Dépendances exterieurs

Dépendance à UnicaenPrivilège

1. Dans vendor/unicaen/mail/config/merged/mail.config.php : UnicaenPrivilege\Guard\PrivilegeController pour les gardes liées aux actions. Peut être directement remplacer par l'equivalent fournit par unicaen/auth.

2. Dans vendor/unicaen/mail/src/UnicaenMail/Provider/Privilege/MailPrivileges.php : UnicaenPrivilege\Provider\Privilege\Privileges classe mère des privilèges du module. Peut être directement remplacer par l'equivalent fournit par unicaen/auth.