Difference between revisions of "Module EMailing (developer)"

Latest revision as of 19:19, 8 October 2021

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/class/mailing.class.php.

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

Process

See user documentation.

Available Scripts

Script mailing-send.php

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 1: / Line 1: @@
+<!-- BEGIN origin interlang links -->
+<!-- You can edit this section but do NOT remove these comments
+     Links below will be automatically replicated on translated pages by PolyglotBot -->
+[[fr:Module_Mailing_(développeur)]]
+[[es:Módulo_Mailing_(desarrollador)]]
+<!-- END interlang links -->
 [[Category:Mailing]]
 {{TemplateDocDevEn}}
+{{TemplateModEN Developer}}
 {{BasculeDevUserEn|
 name=Mailing|
@@ Line 7: / Line 15: @@
 userdoc=[[Module EMailing]]}}
-= Function =
+=Function=
 This module add a tool to create and send emailings.
-= Entity EMailing =
+=Entity EMailing=
 {{TemplateDocDevEntityEn|
-class=htdocs/comm/mailing/mailing.class.php}}
+class=htdocs/comm/mailing/class/mailing.class.php}}
-= 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).
+=Process=
+See user documentation.
-- 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.
+=Available Scripts=
-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.
+*[[Script mailing-send.php]]
-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.
+=Permissions=
-= Scripts mis en oeuvre =
-#[[Script mailing-send.php]]
-Prend en paramètre l'id du mailing à envoyer.
-<pre>
-Usage: mailing-send.php  id_mailing
-</pre>
-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
@@ Line 47: / Line 36: @@
 *->mailing->supprimer
-= Tables SQL =
+=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.
+*[[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.