finesse/swiftmailer-defaults-plugin

A plugin for SwiftMailer that sets default properties for Messages (from, sender, reply to and so on)

v2.0.1 2017-10-25 10:16 UTC

README

Latest Stable Version Total Downloads Build Status Coverage Status Dependency Status SensioLabsInsight

This plugin adds a possibility to set default parameters for sent Messages (default from address, reply to, subject and so on).

// Set up a Mailer
$transport = new Swift_SmtpTransport();
$mailer = new Swift_Mailer($transport);
$mailer->registerPlugin(new Finesse\SwiftMailerDefaultsPlugin\SwiftMailerDefaultsPlugin([
    'from' => ['johndoe@example.com' => 'John Doe'],
    'replyTo' => 'jackdoe@example.com'
]));

// Use the Mailer many times
$mailer->send(
    (new Swift_Message())
        ->setTo('bjohnson@example.com', 'Bill Johnson')
        ->setSubject('Hi')
        ->setBody('This is awesome, I don\'t need to specify the from address!')
);

How to install

Using composer

Run in a console

composer require finesse/swiftmailer-defaults-plugin

How to use

When you setup a Swift_Mailer instance, create and register the plugin.

use Finesse\SwiftMailerDefaultsPlugin\SwiftMailerDefaultsPlugin;
use Swift_Mailer;
use Swift_SmtpTransport;

// Setup you email send transport
$transport = new Swift_SmtpTransport();

// Create a plugin instance
$defaultsPlugin = new SwiftMailerDefaultsPlugin(/* default properties */);

// Assemble them
$mailer = new Swift_Mailer($transport);
$mailer->registerPlugin($defaultsPlugin);

When you need to send a email, just send it without specifying the default properties you set in the plugin instance.

use Swift_Message;

$message = new Swift_Message();
$mailer->send($message);

If you specify, the specified properties will override the default properties.

__constructor

You can pass to the constructor all the properties which you can set to a Swift_Mime_SimpleMessage instance using the set... methods. For example:

$defaultsPlugin = new SwiftMailerDefaultsPlugin([
    'from' => 'johndoe@example.com',
    'subject' => 'Notification'
]);

The array indexes are the names of the properties which are the Swift_Mime_SimpleMessage methods names without the set word and with lowercase first letter. For example, the body property corresponds to the setBody method, readReceiptTo to setReadReceiptTo and so on.

The array values are the first and the only arguments for the corresponding methods. Properties with the null value are discarded.

setDefault

Sets a default value for a property.

$defaultsPlugin->setDefault('sender', 'chasy@example.com', 'Chasy');

The first argument is the property name (see __constructor for reference). The rest arguments are the corresponding method arguments.

unsetDefault

Removes a default value

$defaultsPlugin->unsetDefault('sender');

The only argument is the property name (see __constructor for reference).

Versions compatibility

The project follows the Semantic Versioning.

License

MIT. See the LICENSE file for details.