jMailer options shall be edited in var/config/localconfig.ini.php, in a [mailer] section.

Main configuration options ¶

SMTP configuration options ¶

[smtp:mymailer]
host = localhost
; usually 587, 465 or 25 (unsecure)
port = 587
; secured connection or not (possible value: "", "ssl", "tls" or "unencrypted")
secure_protocol = tls
timeout = 20

; indicate if a username/password is required
auth_enabled = on
username = "me@foo"
password = thepassword

[mailer]
webmasterEmail = webmaster@foo.com
mailerType = smtp
smtpProfile = mymailer

[mailer]
webmasterEmail = webmaster@foo.com
mailerType = smtp

; deprecated parameters for smtp configuration
smtpHost = localhost
smtpPort = 465
smtpSecure = ssl
smtpHelo=
smtpTimeout = 20
smtpAuth = on
smtpUsername = "me@foo"
smtpPassword = thepassword

Sending a text email.

  $mail = new jMailer();

  $mail->Subject = 'Subject';
  $mail->Body = 'Text content';

  $mail->AddAddress('recipientId@exemple.com' , 'recipient name');

  $mail->Send();

You can use the powerful template engine of Jelix to send an email. You have to create a template in your module. In this template, you can use meta values to specify your email parameters.

Example, in modules/mymodule/templates/supermail.tpl:

    {meta Subject 'Super mail.'}
    {meta Priority 1}
    {meta From 'your name<your@email.com>'}
    {meta Sender 'your@email.com'}
    {meta ReplyTo array('your name<your@email.com>')}
    {meta to array($name.'<'.$email.'>')}
    {meta cc array('titi <titi@example.com>')}
    {meta bcc array('tutu <tutu@example.com>')}

    Hello {$name},
    Here is an email generated by jMailer and Jelix.

And in your PHP code :

    $mail = new jMailer();
    $tpl = $mail->Tpl('mymodule~supermail');
    $tpl->assign('name', 'Mister Toto');
    $tpl->assign('email', 'toto@example.com');
    $mail->Send();

Notice that jMailer will create template variables corresponding to some PHPMailer properties, so you can use it them anywhere in the template

    {meta Subject 'Super mail.'}
    {meta Priority 1}
    {meta From 'your name<your@email.com>'}
    {meta Sender 'your@email.com'}
    {meta ReplyTo array('your name<your@email.com>')}
    {meta to array($name.'<'.$email.'>')}
    {meta cc array('titi <titi@example.com>', 'tutu <tutu@example.com>')}

    Hello {$name},
    Here is an email generated by jMailer and Jelix.
    This email is send to : 
    {foreach $cc as $person}
      - {$person[0]}
    {/foreach}

You have to call the isHTML method like in this example:

$mail = new jMailer();
$mail->isHTML(true);
$mail->Body = "<p>My <strong>HTML</strong> email !</p>";
$mail->AddAddress('toto@example.com' , 'Toto');
$mail->Send();

An alternative way is to give a template with HTML content, and so you have to indicate true to the method Tpl.

$tpl = $mail->Tpl('mymodule~htmlmail', true);

PHPMailer include the HTML content in the email, but also a plain text version of the content, by removing HTML elements and their attributes, CSS, javascript code. jMailer improves the process by keeping links of the <a> elements, between parenthesis after the label of the link, except if there is a class or an attribute named notexpandlink.

You can provide your own HTML to text converter, by indicating it as the third parameter to Tpl(). It should be a callable type:

$tpl = $mail->Tpl(
    'mymodule~supermail',
    true,
    function ($html) {
        // ... convert to text
        return $text;
    }
);

Your HTML may content some images with the <img> element. If the src attribute is not an URL, then PHPMailer considers it as a file to include into the mail. The path to the image may be a full path. But if it is a relative path, you should indicate the base directory of all images to resolve paths.

In this example, images referred into the HTML are in the www/images/ of the application:

$tpl = $mail->Tpl(
    'mymodule~supermail',
    true,
    null,
    jApp::wwwPath('images/')
);

You can add attachment easily in your email, by giving the path of the file stored somewhere on the hard drive. You can also indicate an other name for the file.

$mail = new jMailer();
$mail->AddAttachment(jApp::varPath('original_filename.pdf'), 'new_filename.pdf');
...
$mail->Send();

Since jMailer inherits from the PHPmailer class, read the API documentation of PHPMailer to know more about its features.

If you want to test the configuration of jMailer, you can launch the command php console.php mailer:test. Give an email address to this command, and an email will be send to it.

` php console.php mailer:test john.doe@example.com `

In some environment for tests, like on your computer, you may not want to send emails. Set mailerType to file and all emails generated by jMailer will be stored into files, into your var/mails/ directory.

On a demo server, you may want to send emails, but you want to debug or have more controls on sent emails.

If you want for example to have a copy of all emails into files, set copyToFiles = on in the mailer section.

Starting with Jelix 1.6.17, you can force receivers, so all emails will be send to them instead of receivers indicated to jMailer by the application.

To activate this feature, set debugModeEnabled = on, and list receivers into debugReceivers. Here, all emails will be sent only to Bob and Joe:

debugModeEnabled = on
debugReceivers[] = bob@foo.local
debugReceivers[] = joe@foo.local

You have also additional features:

; Prefix to add to subject of mails, in debug mode.
debugSubjectPrefix = "[DEMO] "

; Introduction inserted at the beginning of the messages in debug mode
debugBodyIntroduction = "This is a mail from test. Here are real headers: "

; type of receivers set into the email
; 1: only addresses from  debugReceivers
; 2: only email address of the authenticated user, or addresses from  debugReceivers
;    if the user isn't authenticated
; 3: both, addresses from debugReceivers and address of the authenticated user
debugReceiversType = 3

; Receivers for 'To' having these emails will not be replaced by debugReceivers
; Receivers for 'Cc' and 'Bcc' having these emails will not be removed
debugReceiversWhiteList[] = john@foo.local

You can also debug the SMTP communication. Use the debugSmtpLevel configuration parameter to sets the level of debug. Output will be done into log files. Levels:

• 0: No output
• 1: Commands
• 2: Data and commands
• 3: like 2 plus connection status
• 4: Low-level data output