lingtalfi/mailer

A simple mailer wrapper for SwiftMailer

Mailer

2016-12-23

A simple mailer wrapper for SwiftMailer.

This is part of the universe framework.

How to install

You first need SwiftMailer. To install swift mailer, use composer:

composer require swiftmailer/swiftmailer

How to use

The AppMailer class was designed to be fast to use.

You first need to put some constants in your init.

Note: if you don't like constants, you can still use the Mailer class.

//------------------------------------------------------------------------------/
// MAILER CONFIG
//------------------------------------------------------------------------------/
define('MAILER_HOST', 'smtp.example.org');
define('MAILER_PORT', 25);
define('MAILER_USER', "your username");
define('MAILER_PASS', "your password");
define('MAILER_SENDER', "[email protected]");
define('MAILER_ADMIN', "[email protected]");

Now you can use the AppMailer.

Send a message to yourself

To send yourself a message, use the notif method:

AppMailer::create()->notif("alert: an exception occurred in...")->send();

Send a message to somebody else

To send a message to somebody else, use the send method.

$nbMsgSend = AppMailer::create()
    ->subject("Your registration on MyWebsite.com")
    ->messageHtml('Hi <b>Marie</b>. Thank you for registering...')
    ->to("[email protected]")
    ->send();

Debug mode

If you are in development mode, you can use the AppMailer debug mode, it will skip the sending of mail, but will otherwise work as usual (i.e. returning the expected output).

AppMailer::$debug = true;
$nbMsgSend = AppMailer::create()
    ->subject("Your registration on MyWebsite.com")
    ->messageHtml('Hi <b>Marie</b>. Thank you for registering...')
    ->to("[email protected]")
    ->send(); // return 1

Dependency

• SwiftMailer

History Log

• 2.0.1 -- 2016-12-23

  • fix AppMailer->notif in debug mode

• 2.0.0 -- 2016-12-23

  • AppMailer->notif now returns the instance and doesn't send the message

• 1.0.0 -- 2016-12-23

  • initial commit