Difference between revisions of "Module EMailing"

Latest revision as of 10:23, 23 January 2025

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

Introduction

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

Installation

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

Setup

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 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

Check also the setup options available in Setup Other, for the emailing module. Amongst others, you can set the number of emails to be sent from your web interface with MAILING_LIMIT_SENDBYWEB.

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

Usage

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" of the predefined lists you want).

- You can modify this list, by removing targets for example, orcadding targets from dufferent sources.

- 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:

the web application screen. In such a case, there is a limit in number of emails sent in one step, 50 by defaut in most cases. If you have more than 50 recipients, you can submit the emailing from screen a second time and the application will automatically send emails to the 50 next recipients. Repeat until all recipients are addressed.
or from the command line with script Script mailing-send.php.

Only an emailing with the 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.

@@ 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]]
+[[es:Módulo_Mailing]]
+<!-- END interlang links -->
 {{TemplateDocUser}}
+{{TemplateModEN}}
 {{BasculeDevUserEn|
 name=Mailing|
@@ Line 6: / Line 14: @@
 userdoc=This page}}
-= Introduction =
+=Introduction=
-{{ToTranslate}}
+This module permits to send mass emailing to your customers, suppliers, prospects, contacts, members, or users.
-Les fonctions de mailings sont accessibles depuis le menu (sous condition que le module [[Mailing]] ait été activé).
-On trouve le lien Mailing dans le menu du haut sur le gestionnaire de menu "''Defaut''" ou dans le menu "''Outil''" sur le gestionnaire de menu "''Eldy''".
+=Installation=
+{{NoInstallModuleEn}}
+=Setup=
+{{ActivationModuleEn}}
+Check also that Dolibarr setup to send mails is ok: [[Setup EMails]]
-- Le principe est de créer un mailing avec un titre, un sujet, un email expéditeur.
+Check also the setup options available in [[Setup Other|Setup Other, for the emailing module]]. Amongst others, you can set the number of emails to be sent from your web interface with MAILING_LIMIT_SENDBYWEB.
-- On choisit ensuite les destinataires, dans des listes prédéfinies.
+[[File: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 the send mode in setup is not on "PHP Mail" but on another mode (like "SMTPs").
-- On affine le choix issu de ces listes (pour supprimer un ou deux destinataires par exemple).
+=Usage=
+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''".
-- Le responsable validation valide le contenu du mailing et sa liste de destinataires. Il peut effectuer un test vers sa propre adresse e-mail pour en vérifier le rendu sur son logiciel de messagerie.
+==Life cycle / Business rules==
-Si le résultat et la liste des destinataires lui conviennent, il passe le mailing au statut validé.
+The full process is this one:
-- L'envoi du mail en masse se fait ensuite en ligne de commande via le [[Script mailing-send.php]].
+- 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").
-- Le statut global du mailing, ainsi que de le résultat de l'envoi pour chaque destinataire, est mis à jour par ce script.
+- 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" of the predefined lists you want).
-= Installation =
+- You can modify this list, by removing targets for example, orcadding targets from dufferent sources.
-{{NoInstallModuleEn}}
+- 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:
-= Configuration =
+*the web application screen. In such a case, there is a limit in number of emails sent in one step, 50 by defaut in most cases. If you have more than 50 recipients, you can submit the emailing from screen a second time and the application will automatically send emails to the 50 next recipients. Repeat until all recipients are addressed.
-{{ActivationModuleEn}}
+*or from the command line with script [[Script mailing-send.php]].
-= Cycle de vie / Règles de gestion =
+Only an emailing with the 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.
-A compléter
-= Exemple de cas d'utilisations =
+- The global status for e-mailing and send result for each recipient will be updated and visible.
-A compléter