Module EMailing

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

Numero/ID of module 22
User doc. of module This page
Developer doc. of module Module EMailing (developer)


This module permits to send mass emailing to your customers, suppliers, prospects, contacts, members, or users.


This module is included with the Dolibarr distribution, so there is no need to install it.


To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.

Check also that Dolibarr setup to send mails is ok: Setup EMails

Warning.png Note: If a constant MAILING_NO_USING_PHPMAIL is set to 1 in Home - Setup - Other, it is only possible to send emailing when setup is not on "PHP Mail" but on another option (like "SMTPs").


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

Life cycle / Business rules

The full process is this one:

- You create an emailing with a title, a topic and an email sender (For this, click on menu "Tools - EMailings - New emailing", input the content of the email with substitue variables and click on "Create emailing" button. The other solution is to go on an existing emailing and click "Clone").

- Then you choose the targets, among predefined dynamic lists from your Dolibarr data or from external files (For this, go on tab "Recipients" and click on button "Add" for predefined lists you want).

- You can modify this list, by removing 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 its email software. If results looks good, he set the status of e-mailing to validated (For this, click on button "Validate").

- The mass e-mail sending is done then from screen or command line with script 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 will be updated and visible.