Difference between revisions of "Module EMailing (developer)"

Revision as of 13:17, 9 November 2009

Mailing
Numero/ID of module	22
User doc. of module	Module EMailing
Developer doc. of module	This page

Function

This module add a tool to create and send emailings.

Entity EMailing

The PHP class to use to manipulate such object is file htdocs/comm/mailing/mailing.class.php.

It contains CRUD methods to create (C), read (R), update (U) and delete (D) this object.

Process

Mass E-Mailing features are available from menus (if Module EMailing has been activated). Menu link can be found in top menu with menu manage "Rodolphe" or in menu "Tools" with default menu manager "Eldy".

- The process to create an emailing with a title, a topic and an email sender.

- Then you choose the targets, among predefined dynamic lists from your Dolibarr data or from external files.

- You can enhance this lists (by removing or adding targets for example).

- The user responsible to validate emailing checks content and recipients. He can do a test to its own e-mail address to see the result inside an email software. If results looks good, he set the status of e-mailing to validated.

- The mass e-mail sending is done from command line with command shown on screen (See Script mailing-send.php). Only an emailing with status Validated can be sent by the script. See page Script mailing-send.php for more information on how to launch it from command line.

- The global status for e-mailing and send result for each recipient is updated by this script.

Scripts mis en oeuvre

Script mailing-send.php

Prend en paramètre l'id du mailing à envoyer.

Usage: mailing-send.php  id_mailing

L'envoi n'est réalisé que pour les destinataires qui n'ont pas déjà réçu le mail. .

Permissions

->mailing->lire
->mailing->creer
->mailing->valider
->mailing->supprimer

Tables SQL

Table llx_mailing : Table contenant les mailings (sujet, corps du text et statut global)
Table llx_mailing_cibles : Table contenant la liste des destinataires définis pour ce mailing et le statut de l'envoi par destinataire.

@@ Line 15: / Line 15: @@
 = Process =
-{{ToTranslate}}
+Mass E-Mailing features are available from menus (if [[Module EMailing]] has been activated).
+Menu link can be found in top menu with menu manage "''Rodolphe''" or in menu "''Tools''" with default menu manager "''Eldy''".
-- Le principe est de créer un mailing avec un titre, un sujet, un email expéditeur.
+- The process to create an emailing with a title, a topic and an email sender.
-- On choisit ensuite les destinataires, dans des listes prédéfinis.
+- Then you choose the targets, among predefined dynamic lists from your Dolibarr data or from external files.
-- On affine le choix issus de ces listes (pour supprimer un ou deux destinataires par exemple).
+- You can enhance this lists (by removing or adding targets for example).
-- Le responsable validation valide le contenu du mailing et sa liste de destinataires. Il peut effectuer un test vers son propre email pour un vérifier le rendu sur son logiciel de messagerie.
+- The user responsible to validate emailing checks content and recipients. He can do a test to its own e-mail address to see the result inside an email software.
-Si le résultat et la liste des destinataires lui conviennent, il passe le mailing au statut validé.
+If results looks good, he set the status of e-mailing to ''validated''.
-- L'envoi du mail en masse se fait ensuite en ligne de commande via le script ''scripts/mailing-send.php''.
+- The mass e-mail sending is done from command line with command shown on screen (See [[Script mailing-send.php]]). Only an emailing with status Validated can be sent by the script.
-<pre>
+See page [[Script mailing-send.php]] for more information on how to launch it from command line.
-Usage: mailing-send.php  id_mailing
-</pre>
-Seul un mail au statut validé, peut etre réalisé par ce script.
-- Le statut global du mailing, ainsi que de le résultat de l'envoi pour chaque destinataire, est mis à jour par ce script.
+- The global status for e-mailing and send result for each recipient is updated by this script.
 = Scripts mis en oeuvre =