Mailers

All Plugins / Core / Mailer

Identity Card

StatusCore
Plugin LabelMailers
Short DescriptionCore configs for sending emails
Plugin Identifiercore.mailer
AuthorCharles du Jeu
Urldocs/references/plugins/core/mailer
Dependencies

Documentation

Generic options provider for all mailer plugins.

Select the plugin to use for sending emails and set up its preferences. Make sure that a "Sender Email" is sent, otherwise the mails will not work. Mail problems can be quite complicated to troubleshoot, so please make sure that your PHP and server is correctly configured to send email, by testing a super-simple php script.

Layout Folder contains a set internationalized lang.html files, loaded to be a common layout to all sent emails.

Plugin parameters

LabelDescriptionTypeDefault
Activate Queue
MAILER_ACTIVATE_QUEUE
Store emails in a queue and batch-process them. Users can choose the sending frequency. Make sure to set up a CRON on consume_mail_queue action if you use this option.Booleanfalse
Mailer Plugin *
UNIQUE_MAILER_INSTANCE
Select the plugin to activate for concretely sending emailsPlugin_instance:mailermailer.phpmailer-lite
Sender
Sender email *
FROM
Adress of the senderString
Sender name *
FROM_NAME
Name of the senderString
Unique Sender *
FORCE_UNIQUE_FROM
Force all mails to be sent by this Sender email, instead of users adressesBooleanfalse
Content
Subject Prepend
SUBJECT_PREPEND
String automatically added at the beginning of the mail subjectString
Subject Append
SUBJECT_APPEND
String automatically added at the end of the mail subjectString
Body Layout
BODY_LAYOUT
Main Layout for the email body, use HTML for send nice emails, and use the AJXP_MAIL_BODY keyword for the real content.TextareaAJXP_MAIL_BODY
Layout Folder
LAYOUT_FOLDER
Extract the main layout from a localized file. Will prevail on the previous parameter, make sure to have an AJXP_MAIL_BODY in the layout file.Stringplugins/core.mailer/layout

Instance parameters

LabelDescriptionTypeDefault
Active notifications by email *
NOTIFICATIONS_EMAIL_GET
Receive Notifcations by emailSelect (true, false)true
Emails frequency *
NOTIFICATIONS_EMAIL_FREQUENCY
Emails frequencySelect (M, H, D1, D2, W1)M
Detail your frequency here *
NOTIFICATIONS_EMAIL_FREQUENCY_USER
Choose your mail frequency (like 9:00 or 9:00,14:00 or Wednesday)String5
Send email to...
NOTIFICATIONS_EMAIL
You can add many email separated by commasString
Get the email in HTML *
NOTIFICATIONS_EMAIL_SEND_HTML
Send as HTMLSelect (true, false)true