parfumix/mailer

Mailer based on swift mailer.

dev-master 2017-07-21 08:23 UTC

Requires

• php: >=7.0.0
• monolog/monolog: 1.x-dev
• swiftmailer/swiftmailer: 5.x

MIT

• Radu

• mailer
• swift-mailer

README

Mailer is a simple package based on SwiftMailer which allow sending messages with different drivers.

Instalation

You can use the composer package manager to install. Either run:

$ php composer.phar require parfumix/mailer "dev-master"

or add:

"parfumix/mailer": "dev-master"

to your composer.json file

Configuration

If you use DotEnv package all you have to do is to populate your .env file.

MAIL_DRIVER=smtp // Allow to select transport
MAIL_HOST=smtp.gmail.com
MAIL_PORT=465
MAIL_USERNAME=[e-mail]
MAIL_PASSWORD=your_password
MAIL_ENCRYPTION=ssl

and start using

$mailer = (new Mailer(
    new Mailer\Transport
))->alwaysFrom('[e-mail]', 'Your name')
    ->alwaysReplyTo('reply_to@gmailcom', 'Reply name');

If you use other storage repository you can create new Mailer instance and populate with config data from array

$config = array(
    'driver' => 'smtp',
    'host' => 'smtp.gmail.com',
    'port' => 465,
    'username' => '[e-mail]',
    'password' => 'your_passwd',
    'encryption' => 'ssl'
);

$mailer = (new Mailer\Mailer(
    new Mailer\Transport( $config )
))->alwaysFrom('[e-mail]', 'Your name')
    ->alwaysReplyTo('reply_to@gmailcom', 'Reply name');

If you want add custom transport all you have to do is to create new transport class which implement TransportAble

class ArrayTransport extends Transport
    implements TransportAble {
    
    /**
     * {@inheritdoc}
     */
    public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
        $this->beforeSendPerformed($message);
        
        // Send your message
    
        return $this->numberOfRecipients($message);
    }
}

And register driver to Transport class.

$tranport = (new Mailer\Transport([
    'driver' => 'my_driver'
]))->extend('my_driver', function($transport) {
    return new ArrayTransport()
});
    
$mailer = (new Mailer($tranport))
->alwaysFrom('[e-mail]', 'Your name')
    ->alwaysReplyTo('reply_to@gmailcom', 'Reply name');

Usage

You can use directly Mailer and send messages by using ::to('[e-mail]') method

$mailer->to('[e-mail]', 'Subject')
    ->send('This is a test message');

$mailer->to('[e-mail]', 'Subject')->send('Message body', null, function (\Mailer\Message $message) {
    return $message->setFrom('[e-mail]');
});

or you can create Mailable classes which require build method

class NewPayment extends \Mailer\Mail
    implements \Mailer\Mailable {

    public function build() {
        $this->text('Body message');
    }
}

$mailer->to(array(
    '[e-mail]'
))->send( new NewPayment('Subject message') );

You can change driver using with method:

$mailer->to('[e-mail]', 'Subject')
    ->with('sendmail')
    ->send('This is a test message');