Le paramétrage de base utilisé par jMailer s'effectue dans le fichier var/config/localconfig.ini.php de votre application dans la section [mailer].

Les différentes options de configuration ¶

[smtp:mymailer]
host = localhost
auth_enabled = one
secure_protocol = tls
username = me@foo
password = thepassword
timeout = 20

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

Envoi d'un email texte avec le paramétrage par défaut.

  $mail = new jMailer();

  $mail->Subject = 'Sujet de l\'email';
  $mail->Body = 'Contenu du message texte';

  $mail->AddAddress('destinataire@exemple.com' , 'Nom du destinataire');

  $mail->Send();

Vous pouvez utiliser toutes la puissance de jTpl a l'intérieur de vos mail. Pour Cela il vous suffit de créer un fichier .tpl dans l'un de vos module.

ex :

 {* fichier modules/monmodule/templates/supermail.tpl *}
    {meta Subject 'Super mail.'}
    {meta Priority 1}
    {meta From 'votre nom<votre@mail.com>'}
    {meta Sender 'votre@mail.com'}
    {meta ReplyTo array('votre nom<votre@mail.com>')}
    {meta to array($name.'<'.$email.'>')}
    {meta cc array('titi <titi@example.com>')}
    {meta bcc array('tutu <tutu@example.com>')}

    Salut {$name},

    Voici un super mail généré par jMailer et Jelix.

Et dans votre code PHP :

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

Il est à noter que jMailer créé des variables de templates correspondantes à des propriétés (protégées) de PHPMailer. Vous pouvez ainsi y accéder dans votre template.

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

    Salut {$name},

    Voici un super mail généré par jMailer et Jelix. Il est en copie à :
    {foreach $cc as $person}
      - {$person[0]}
    {/foreach}

Pour envoyer un email en HTML, il suffit d'appeler la méthode isHTML comme dans l'exemple suivant :

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

Si vous utilisez un template, indiquer true à la méthode Tpl.

$tpl = $mail->Tpl('monmodule~supermail', true);

L'envoi de fichier en pièce jointe se fait très simplement, en donnant le chemin du fichier stocké sur le disque, et le nom que l'on veut faire apparaitre.

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

jMailer utilise comme base PHPMailer, si vous voulez avoir d'avantage de documentation, consultez la documentation de PHPMailer.

Dans certains environnement de tests, comme votre machine de développement, vous ne voudriez pas envoyer de mail. Pour désactiver l'envoi de mail, mettez mailerType = file, et tous les mails seront enregistrés dans des fichiers dans var/mails/. Cela vous permet de vérifier le contenu des mails qui ont été générés.

Sur un serveur de démo où vous voulez quand même envoyer des mails, vous avez des fonctionnalités qui facilitent le débuggage.

Si vous voulez par exemple avoir une copie fichier de tous les emails envoyés, mettez copyToFiles = on dans la section mailer.

À partir de Jelix 1.6.17, vous pouvez forcer les destinataires des mails, ainsi tous les mails iront chez eux plutôt que chez le destinataire indiqué dans le mail.

Pour activer cette fonctionnalité, mettez debugModeEnabled = on, et la liste des destinataires dans debugReceivers. Ici, tous les mails seront envoyés à Bob et à Joe, même si d'autres destinataires sont indiqués dans les mails.

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

Vous avez d'autre paramètres :

; Préfixe à ajouter au sujet des mails
debugSubjectPrefix = "[DEMO] "

; Phrase précédent la liste des en-têtes originaux insérés dans le corp du mail
debugBodyIntroduction = "This is a mail from test. Here are real headers: "

; Type de destinataires à forcer
; 1: uniquement les adresses indiquées dans debugReceivers
; 2: uniquement l'utilisateur courant si il a un email, ou à debugReceivers si il
;    n'est pas authentifié
; 3: les deux, adresses de debugReceivers et adresse de l'utilisateur courant
debugReceiversType = 3

; Les destinataires suivants à qui sont envoyés les mails (direct ou en copie),
; reçevront leurs emails et ne seront donc pas remplacé par ceux de debugReceivers
debugReceiversWhiteList[] = john@foo.local