Module EMailing (developer)

Return to developer
documentation index

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

1. Script mailing-send.php

Permissions

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

Tables SQL

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