aboutsummaryrefslogtreecommitdiffstats
path: root/config
diff options
context:
space:
mode:
Diffstat (limited to 'config')
-rw-r--r--config/config.sample.php5
1 files changed, 4 insertions, 1 deletions
diff --git a/config/config.sample.php b/config/config.sample.php
index d5a3f0ee017..96377b7dbf0 100644
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -521,7 +521,7 @@ $CONFIG = [
'mail_smtpdebug' => false,
/**
- * Which mode to use for sending mail: ``sendmail``, ``smtp`` or ``qmail``.
+ * Which mode to use for sending mail: ``sendmail``, ``smtp``, ``qmail`` or ``null``.
*
* If you are using local or remote SMTP, set this to ``smtp``.
*
@@ -531,6 +531,9 @@ $CONFIG = [
* For ``qmail`` the binary is /var/qmail/bin/sendmail, and it must be installed
* on your Unix system.
*
+ * Use the string ``null`` to send no mails (disable mail delivery). This can be
+ * useful if mails should be sent via APIs and rendering messages is not necessary.
+ *
* Defaults to ``smtp``
*/
'mail_smtpmode' => 'smtp',