pkj/minibase-plugin-mailer

This plugin adds easy mailing support for Minibase applications. Uses SwiftMailer library.

dev-master 2013-04-30 01:46 UTC

Requires

• php: >=5.4.0
• minibase/minibase: dev-master
• swiftmailer/swiftmailer: 4.*

MIT

• Petter Kjelkenes

README

Adds mailing support for Minibase application. Uses the Swiftmailer library to send emails. Easy to configure to forexample use gmail as SMTP server.

Install

{
  "require":{
	     "pkj/minibase-plugin-mailer": "dev-master"
	}
}

Setup

Init the plugin

$mb->initPlugins(array(
	'Pkj\Minibase\Plugin\MailerPlugin\MailerPlugin' => array(
		// This configures Swiftmailer to use Gmail as smtp.
		'transport' => 'smtp',
		'encryption' => 'ssl',
		'auth_mode' => 'login',
		'host' => 'smtp.gmail.com',
		'username' => 'your gmail username',
		'password' => 'your gmail password'
	)
));

Possible configuration keys:

• transport (smtp, mail, sendmail, loadbalanced or failover)
• username
• password
• host
• port
• encryption (tls, or ssl)
• auth_mode (plain, login, or cram-md5)
• sendmailCommand (if using sendmail transport, you can customize the default command /usr/sbin/sendmail -bs)
• mailParams (if you want to customize the mailparams, used by the mail transport -f%s)
• transports (array of transport configuratioins, used by loadbalanced and failover transport.)

Send emails.

You can send emails from forexample controllers (note $this->mb):

$message = \Swift_Message::newInstance()
        ->setSubject('Hello Email')
        ->setFrom('[e-mail]')
        ->setTo('[e-mail]')
        ->setBody("Hello World!");

$this->mb->mailer->send($message);