Kirby Mailer Wrapper

Version 1.05

A wrapper around the kirby mailer, with two new email drivers included.

There is also an optional mailer page extension included, check options.

This is also an extension that works with the kirby user manager kirby extension

Installation

Use one of the alternatives below.

1. Kirby CLI

If you are using the Kirby CLI you can install this plugin by running the following commands in your shell:

$ kirby plugin:install lcd344/kirby-mailer-wrapper

2. Clone or download

1. Clone or download this repository.
2. Unzip the archive if needed and rename the folder to mailer.

Make sure that the plugin folder structure looks like this:

3. Git Submodule

If you know your way around Git, you can download this plugin as a submodule:

$ git submodule add https://github.com/LCD344/kirby-mailer-wrapper site/plugins/mailer

Usage

First this includes two kirby mail drivers

1. Log Driver - This will just output the email you created to:

site/logs/mailer.log

Usage

$email = email([
  'to'      => 'mail@example.com',
  'from'    => 'john@doe.com',
  'subject' => 'Yay, Kirby sends mails',
  'body'    => 'Hey, this is a test email!', 
  'attachments' => [file1,file2],
  'service' => 'log'
));

2. PHPMailer driver - This will use PHPMailer to send your email

Usage

$email->send([
  'to'      => 'mail@example.com',
  'from'    => 'john@doe.com',
  'fromName' => 'John Doe',
  'replyTo' => 'jane@doe.com'
  'cc' => ['john@doe1.com','john@doe2.com']
  'bcc' => ['john@doe3.com']
  'subject' => 'Yay, Kirby sends mails',
  'body'    => 'Hey, this is a test email!', 
  'service' => 'log',
  'attachments' => [file1,file2],
  'service' => 'phpmailer',
  'options' => [
    'host' => 'hostname',
    'username' => 'username',
    'password' => 'password',
    'protocol' => 'tls' //optional defaults to ssl
    'port' => '465' //optional defaults to 465
    smptoptions => [
        'ssl' => [
            'verify_peer' => false,
            'verify_peer_name' => false,
            'allow_self_signed' => true
        ]
    ] // optional defaults to the options written here
  ]
]);

3. A wrapper around all all the drivers for kirby mail.

Usage

	$mailer = new lcd344\Mailer(serviceName,[options]); // the options is an array that depends on the service you use
	
    $mailer->to('john@doe.com);
            ->from('jane@doe.com','Jane Doe'); //second variable only used with phpmailer 
            ->replyTo('jane@doe.org');
            ->cc('jane2@doe.com'); //Only phpmailer, can be called multiple times for multiple cc addresses and/or called with an array
            ->bcc('jane3@doe.com'); //Only phpmailer, can be called multiple times for multiple bcc addressess and/or called with an array
            ->attach($page->file('bla.log')->root()); //Only phpmailer and log, can be called multiple times for multiple attachments if you want to pass file and a new file name pass it as an array [$file,#filename]
            ->send("subject","lorem ipsum text");

The wrapper now also includes a templateing option, you can bind a data array and then it will look for the keys in mustaches inside your email to change them - for example :

	$mailer = new lcd344\Mailer("log");

	$mailer->to("john@doe.com")
		->bind(["username" => "john","email" => "john@doe.com"])
		->send("test", "{{username}} ... {{email}}");

will end up sending an email with "john ... john@doe.com". Note: this also supports nested arrays using . notation ('user.name' or 'user.email')

Options

The following options will be used as defaults in the wrapper class (not in drivers) if you define them in your /site/config/config.php file, Any parameters given to the wrapper will override those defaults.:

c::set('mailer.from', 'john@doe.com'); // default from email
c::set('mailer.fromName', 'john doe'); // default from name - phpmailer only
c::set('mailer.replyTo', 'john@doe1.com'); // default reply to address
c::set('mailer.service', 'phpmailer'); // default mailer service

c::set('mailer.amazon.key', 'key'); // default amazon key
c::set('mailer.amazon.secret', 'secret'); // default amazon secret
c::set('mailer.amazon.host', 'host'); // default amazon host

c::set('mailer.postmark.key', 'key'); // default postmark key

c::set('mailer.mailgun.key', 'key'); // default mailgun key
c::set('mailer.mailgun.domain', 'domain'); // default mailgun domain

c::set('mailer.phpmailer.host', 'host'); // default phpmailer host
c::set('mailer.phpmailer.username', 'username'); // default phpmailer username
c::set('mailer.phpmailer.password', 'password'); // default phpmailer password
c::set('mailer.phpmailer.protocol', 'ssl;); // default phpmailer port
c::set('mailer.phpmailer.port', 465); // default phpmailer port
c::set('mailer.phpmailer.smptoptions', []); // default phpmailer smtp options

c::set("mailer.panel",true); // Enable panel side emailing support (disabled by default)
c::set("mailer.panel.drivers",["phpmailer" => "PHP Mailer","log" => "Logger"]); // Select which drivers to suuport with the mailing page in panel.

Requirements

• Kirby 2.3+

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT