NEW(mailing): Allow user to define the number of email sent by batch directly from mailing config page (#32750)

BenjaminFlr · web-flow · commit c6d50cf46b5c · 2025-03-25T12:01:14.000+01:00
* NEW(mailing): Allow user to define the number of email sent by batch

* FIX: incompatibility with conf.php fie

* DEL: MAILING_LIMIT_SENDBYWEB constant from const.php page

* Define the const for all entities instead of specific entity

* Remove note

---------

Co-authored-by: Benjamin Falière &lt;benjamin.faliere@altairis.fr&gt;
diff --git a/htdocs/admin/mailing.php b/htdocs/admin/mailing.php
@@ -3,6 +3,7 @@
  * Copyright (C) 2005-2013 Laurent Destailleur  	<eldy@users.sourceforge.org>
  * Copyright (C) 2011-2013 Juanjo Menent			<jmenent@2byte.es>
  * Copyright (C) 2024       Frédéric France         <frederic.france@free.fr>
+ * Copyright (C) 2025		Benjamin Falière		<benjamin@faliere.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -26,8 +27,8 @@
 
 // Load Dolibarr environment
 require '../main.inc.php';
-require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
-require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
+require_once DOL_DOCUMENT_ROOT . '/core/lib/admin.lib.php';
+require_once DOL_DOCUMENT_ROOT . '/core/lib/security2.lib.php';
 
 /**
  * @var Conf $conf
@@ -63,11 +64,14 @@
 	$checkread = GETPOST('value', 'alpha');
 	$checkread_key = GETPOST('MAILING_EMAIL_UNSUBSCRIBE_KEY', 'alpha');
 	$contactbulkdefault = GETPOSTINT('MAILING_CONTACT_DEFAULT_BULK_STATUS');
+	$batchlimit = GETPOSTINT('MAILING_LIMIT_SENDBYWEB');
+
 	if (GETPOST('MAILING_DELAY', 'alpha') != '') {
 		$mailingdelay = price2num(GETPOST('MAILING_DELAY', 'alpha'), 3);		// Not less than 1 millisecond.
 	} else {
 		$mailingdelay = '';
 	}
+
 	// Clean data
 	if ((float) $mailingdelay > 10) {
 		$mailingdelay = 10;
@@ -92,6 +96,10 @@
 	if (!($res > 0)) {
 		$error++;
 	}
+	$res = dolibarr_set_const($db, "MAILING_LIMIT_SENDBYWEB", $batchlimit, 'chaine', 1, '', 0);
+	if (!($res > 0)) {
+		$error++;
+	}
 
 	// Create temporary encryption key if needed
 	$res = dolibarr_set_const($db, "MAILING_EMAIL_UNSUBSCRIBE_KEY", $checkread_key, 'chaine', 0, '', $conf->entity);
@@ -127,51 +135,52 @@
 
 llxHeader('', $langs->trans("MailingSetup"), '', '', 0, 0, '', '', '', 'mod-admin page-mailing');
 
-$linkback = '<a href="'.DOL_URL_ROOT.'/admin/modules.php?restore_lastsearch_values=1">'.$langs->trans("BackToModuleList").'</a>';
+$linkback = '<a href="' . DOL_URL_ROOT . '/admin/modules.php?restore_lastsearch_values=1">' . $langs->trans("BackToModuleList") . '</a>';
 print load_fiche_titre($langs->trans("MailingSetup"), $linkback, 'title_setup');
 
 $constname = 'MAILING_EMAIL_UNSUBSCRIBE_KEY';
 
 // Add button to autosuggest a key
-include_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
+include_once DOL_DOCUMENT_ROOT . '/core/lib/security2.lib.php';
 print dolJSToSetRandomPassword($constname);
 
 print '<br>';
-print '<form method="post" action="'.$_SERVER["PHP_SELF"].'">';
-print '<input type="hidden" name="token" value="'.newToken().'">';
+print '<form method="post" action="' . $_SERVER["PHP_SELF"] . '">';
+print '<input type="hidden" name="token" value="' . newToken() . '">';
 print '<input type="hidden" name="action" value="setvalue">';
 
 print '<table class="noborder centpercent">';
 print '<tr class="liste_titre">';
 print '<td>'.$langs->trans("Parameter").'</td>';
 print '<td></td>';
 print '<td class="hideonsmartphone">'.$langs->trans("Example").'</td>';
+
 print "</tr>\n";
 
 print '<tr class="oddeven"><td>';
 $help = img_help(1, $langs->trans("EMailHelpMsgSPFDKIM"));
-print $langs->trans("MailingEMailFrom").' '.$help.'</td><td>';
-print '<input class="minwidth100" type="text" name="MAILING_EMAIL_FROM" value="' . getDolGlobalString('MAILING_EMAIL_FROM').'">';
+print $langs->trans("MailingEMailFrom") . ' ' . $help . '</td><td>';
+print '<input class="minwidth100" type="text" name="MAILING_EMAIL_FROM" value="' . getDolGlobalString('MAILING_EMAIL_FROM') . '">';
 if (getDolGlobalString('MAILING_EMAIL_FROM') && !isValidEmail($conf->global->MAILING_EMAIL_FROM)) {
-	print ' '.img_warning($langs->trans("BadEMail"));
+	print ' ' . img_warning($langs->trans("BadEMail"));
 }
 print '</td>';
-print '<td class="hideonsmartphone"><span class="opacitymedium">'.dol_escape_htmltag(($mysoc->name ? $mysoc->name : 'MyName').' <noreply@example.com>').'</span></td>';
+print '<td class="hideonsmartphone"><span class="opacitymedium">' . dol_escape_htmltag(($mysoc->name ? $mysoc->name : 'MyName') . ' <noreply@example.com>') . '</span></td>';
 print '</tr>';
 
 print '<tr class="oddeven"><td>';
-print $langs->trans("MailingEMailError").'</td><td>';
-print '<input class="minwidth100" type="text" name="MAILING_EMAIL_ERRORSTO" value="'.getDolGlobalString('MAILING_EMAIL_ERRORSTO').'">';
+print $langs->trans("MailingEMailError") . '</td><td>';
+print '<input class="minwidth100" type="text" name="MAILING_EMAIL_ERRORSTO" value="' . getDolGlobalString('MAILING_EMAIL_ERRORSTO') . '">';
 if (getDolGlobalString('MAILING_EMAIL_ERRORSTO') && !isValidEmail(getDolGlobalString('MAILING_EMAIL_ERRORSTO'))) {
-	print ' '.img_warning($langs->trans("BadEMail"));
+	print ' ' . img_warning($langs->trans("BadEMail"));
 }
 print '</td>';
-print '<td class="hideonsmartphone"><span class="opacitymedium">'.dol_escape_htmltag('<webmaster@example.com>').'</span></td>';
+print '<td class="hideonsmartphone"><span class="opacitymedium">' . dol_escape_htmltag('<webmaster@example.com>') . '</span></td>';
 print '</tr>';
 
 print '<tr class="oddeven"><td>';
-print $form->textwithpicto($langs->trans("MailingDelay"), $langs->trans("IfDefinedUseAValueBeetween", '0.001', '10')).'</td><td>';
-print '<input class="width75" type="text" name="MAILING_DELAY" value="'.getDolGlobalString('MAILING_DELAY').'">';
+print $form->textwithpicto($langs->trans("MailingDelay"), $langs->trans("IfDefinedUseAValueBeetween", '0.001', '10')) . '</td><td>';
+print '<input class="width75" type="text" name="MAILING_DELAY" value="' . getDolGlobalString('MAILING_DELAY') . '">';
 print '</td>';
 print '<td class="hideonsmartphone"></td>';
 print '</tr>';
@@ -181,10 +190,10 @@
 // It is also used as a security key parameter.
 
 print '<tr class="oddeven"><td>';
-print $langs->trans("ActivateCheckReadKey").'</td><td>';
-print '<input class="minwidth100 maxwdith250 widthcentpercentminusx" type="text" name="MAILING_EMAIL_UNSUBSCRIBE_KEY" id="MAILING_EMAIL_UNSUBSCRIBE_KEY" value="'.getDolGlobalString('MAILING_EMAIL_UNSUBSCRIBE_KEY').'">';
+print $langs->trans("ActivateCheckReadKey") . '</td><td>';
+print '<input class="minwidth100 maxwdith250 widthcentpercentminusx" type="text" name="MAILING_EMAIL_UNSUBSCRIBE_KEY" id="MAILING_EMAIL_UNSUBSCRIBE_KEY" value="' . getDolGlobalString('MAILING_EMAIL_UNSUBSCRIBE_KEY') . '">';
 if (!empty($conf->use_javascript_ajax)) {
-	print '&nbsp;'.img_picto($langs->trans('Generate'), 'refresh', 'id="generate_token" class="linkobject"');
+	print '&nbsp;' . img_picto($langs->trans('Generate'), 'refresh', 'id="generate_token" class="linkobject"');
 }
 print '</td>';
 print '<td class="hideonsmartphone"></td>';
@@ -194,16 +203,27 @@
 print '<tr class="oddeven">';
 print '<td>' . $langs->trans("DefaultBlacklistMailingStatus", $langs->transnoentitiesnoconv("No_Email")) . '</td>';
 print '<td>';
-$blacklist_setting=array(0=>$langs->trans('No'), 1=>$langs->trans('Yes'), 2=>$langs->trans('DefaultStatusEmptyMandatory'));
+$blacklist_setting = array(0 => $langs->trans('No'), 1 => $langs->trans('Yes'), 2 => $langs->trans('DefaultStatusEmptyMandatory'));
 print $form->selectarray("MAILING_CONTACT_DEFAULT_BULK_STATUS", $blacklist_setting, getDolGlobalString('MAILING_CONTACT_DEFAULT_BULK_STATUS'));
 print '</td>';
 print '<td class="hideonsmartphone"></td>';
 print '</tr>';
 
+// Limit number for each mailing batch, displayed only if this value is not defined in the conf.php file
+if (empty($conf->file->mailing_limit_sendbyweb)) {
+	print '<tr class="oddeven">';
+	$help = img_help(1, $langs->trans("MailingNumberOfEmailsPerBatchHelp"));
+	print '<td>' . $langs->trans("MailingNumberOfEmailsPerBatch") . ' ' . $help . '</td>';
+	print '<td>';
+	print '<input class="minwidth100 maxwdith250 widthcentpercentminusx" type="text" name="MAILING_LIMIT_SENDBYWEB" id="MAILING_LIMIT_SENDBYWEB" value="' . getDolGlobalString('MAILING_LIMIT_SENDBYWEB') . '">';
+	print '</td>';
+	print '<td class="hideonsmartphone"></td>';
+	print '</tr>';
+}
 
 if (!empty($conf->use_javascript_ajax) && getDolGlobalInt('MAIN_FEATURES_LEVEL') >= 1) {
 	print '<tr class="oddeven"><td>';
-	print $langs->trans("MailAdvTargetRecipients").'</td><td>';
+	print $langs->trans("MailAdvTargetRecipients") . '</td><td>';
 	print ajax_constantonoff('EMAILING_USE_ADVANCED_SELECTOR');
 	print '</td>';
 	print '<td class="hideonsmartphone"></td>';
diff --git a/htdocs/install/mysql/data/llx_const.sql b/htdocs/install/mysql/data/llx_const.sql
@@ -33,8 +33,7 @@
 
 -- Visible in misc page and common to all entities
 insert into llx_const (name, value, type, note, visible, entity) values ('MAIN_NOT_INSTALLED','1','chaine','Setup is running',1,0);
-insert into llx_const (name, value, type, note, visible, entity) values ('MAILING_LIMIT_SENDBYWEB','25','chaine','Number of targets to defined packet size when sending mass email',1,0);
---insert into llx_const (name, value, type, note, visible, entity) values ('MAIN_ENABLE_LOG_TO_HTML','0','chaine','If this option is set to 1, it is possible to see log output at end of HTML sources by adding parameter logtohtml=1 on URL. Module log must also be enabled.',1,0);
+--insert into llx_const (name, value, type, note, visible, entity) values ('MAIN_ENABLE_LOG_TO_HTML','0','chaine','If this option is set to 1, it is possible to see log output at end of HTML sources by adding paramater logtohtml=1 on URL. Module log must also be enabled.',1,0);
 
 -- Visible in misc page but specific to one entity
 insert into llx_const (name, value, type, note, visible, entity) values ('MAIN_FEATURES_LEVEL','0','chaine','Level of features to show: -1=stable+deprecated, 0=stable only (default), 1=stable+experimental, 2=stable+experimental+development',1,__ENTITY__);
@@ -43,6 +42,8 @@ insert into llx_const (name, value, type, note, visible, entity) values ('MAIN_F
 insert into llx_const (name, value, type, note, visible, entity) values ('SYSLOG_HANDLERS','["mod_syslog_file"]','chaine','Which logger to use',0,0);
 insert into llx_const (name, value, type, note, visible, entity) values ('SYSLOG_FILE','DOL_DATA_ROOT/dolibarr.log','chaine','Directory where to write log file',0,0);
 insert into llx_const (name, value, type, note, visible, entity) values ('SYSLOG_LEVEL','7','chaine','Level of debug info to show',0,0);
+insert into llx_const (name, value, type, note, visible, entity) values ('MAILING_LIMIT_SENDBYWEB','25','chaine','Number of targets to defined packet size when sending mass email',0,0);
+
 
 -- Hidden but specific to one entity
 insert into llx_const (name, value, type, note, visible, entity) values ('MAIN_UPLOAD_DOC','2048','chaine','Max size for file upload (0 means no upload allowed)',0,__ENTITY__);
diff --git a/htdocs/install/mysql/migration/21.0.0-22.0.0.sql b/htdocs/install/mysql/migration/21.0.0-22.0.0.sql
@@ -63,6 +63,8 @@ ALTER TABLE llx_societe_account ADD COLUMN ip varchar(250);
 
 ALTER TABLE llx_product ADD COLUMN packaging float(24,8) DEFAULT NULL;
 
+-- mailing
+UPDATE llx_const SET visible = 0 WHERE name='MAILING_LIMIT_SENDBYWEB';
 
 ALTER TABLE llx_categorie_member ADD COLUMN import_key varchar(14);
 ALTER TABLE llx_category_bankline ADD COLUMN import_key varchar(14);
diff --git a/htdocs/langs/en_US/mails.lang b/htdocs/langs/en_US/mails.lang
@@ -204,3 +204,5 @@ ContentOfMailHolder=Content of email goes here...
 LastNews=Latest News
 ListProducts= List of products
 PasswordReset=Password reset
+MailingNumberOfEmailsPerBatch=Number of emails per batch
+MailingNumberOfEmailsPerBatchHelp=Define the number of emails you want to send for each manual sending action. Warning: An important number of emails can lead to your server being blacklisted.
