Mise à jour documentation

-----------

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és à ceux-ci.

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

----------

Mail sont stocké en base avec les informations suivantes :

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

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

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

Exemple d'utilisation sans utilisation d'un template

Exemple d'utilisation sans utilisation d'un template :

```php

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

```

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

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

```php

$rendu = $this->getRenduService()->generateRenduByTemplateCode('MON TEMPLATE', ['VAR1' => $var1, 'VAR2' => $var2, ...]);

$mail = $this->getMailService()->sendMail('john.doe@aol.com', $rendu->getSujet(), $rendu->getCorps());

],

```

`$this->mail($monMails)` : Affiche un mail généré avec description à gauche et texte générée à droite.

`$this->mails($monTableauDeMails)` : Affiche une table avec un ligne par mail et founi les actions associées.

`$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 de bricoler les droits des actions. 

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

```php 

$options['droits'][

    'afficher' => Boolean, 

    'reenvoyer' => Boolean, 

    'supprimer' => Boolean

    ]

```

Configuration

=============

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

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

```php

<?php

| Column | Type | Obligatoire | Unique | Description |

|---|---|---|---|---|

| id | int | true | true | identifiant numerique de la macro |

| id | int | true | true | identifiant numerique du mail |

| date_envoi | timestamp| true | false | date de l'envoi du mail |

| status_envoi | varchar(256) | true | false | Statut "indicatif" de l'envoi : FAILED, SUCCESS, PENDING |

| destinataires | text | true | false | chaines de caractères concaténant les adresse des destinataires |

| destinataires_initials | text | false | false | Null si le mail n'as pas été redirigé. Sinon chaines de caractères concaténant les adresse des destinataires initiaux du mail|

| status_envoi | varchar(256) | true | false | statut "indicatif" de l'envoi : FAILED, SUCCESS, PENDING |

| destinataires | text | true | false | chaîne de caractères concaténant les adresses des destinataires |

| destinataires_initials | text | false | false | Null si le mail n'as pas été redirigé. Sinon chaînes de caractères concaténant les adresse des destinataires initiaux du mail|

| sujet | text | false | false | sujet du mail |

| corps | text | false | false | corps du mail |

| mots_clefs | text | false | false | Champ libre permettant d'associer des mots clés aux mails (ie. id d'une entité, mots clés de recherche ...)|

| mots_clefs | text | false | false | champ libre permettant d'associer des mots clefs aux mails (ie. id d'une entité, mots clés de recherche ...)|

| log | text | false | false | Log du mail |

Privilèges associés au module

```

***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`.

1. Dans **vendor/unicaen/mail/src/UnicaenMail/Provider/Privilege/MailPrivileges.php** : `UnicaenPrivilege\Provider\Privilege\Privileges` classe mère des privilèges du modules. 

Peut être directement remplacer par l'equivalent fournit par `unicaen/auth`.