Download the PHP package andrewdyer/slim3-mailer without Composer
On this page you can find all versions of the php package andrewdyer/slim3-mailer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download andrewdyer/slim3-mailer
More information about andrewdyer/slim3-mailer
Files in andrewdyer/slim3-mailer
Package slim3-mailer
Short Description Email support for the Slim Framework using Twig and Swift Mailer.
License MIT
Homepage https://github.com/andrewdyer/slim3-mailer
Informations about the package slim3-mailer
Slim3 Mailer
Email support for the Slim Framework using Twig and Swift Mailer. Mailable classes will massively tidy up your controller methods or routes, and will make sending email a breeze.
License
Licensed under MIT. Totally free for private or commercial projects.
Installation
Usage
Attach a new instance of Anddye\Mailer\Mailer
to your applications container so
it can be accessed anywhere you need. Mailer
takes two arguements; an instance of
Slim\Views\Twig
and an optional array of SMTP settings.
If your application doesn't use Twig views already, you will need to also attach this to your container.
Supported Options
Option | Type | Description |
---|---|---|
host | string | The host to connect to. |
port | integer | The port to connect to. |
username | string | The username to authenticate with. |
password | string | The password to authenticate with. |
protocol | string | The encryption method, either SSL or TLS. |
Sending the Email (Basic Example)
welcome.html.twig
Sending with a Mailable
Using mailable classes are a lot more elegant than the basic usage example above. Building up the mail in a mailable class cleans up controllers and routes, making things look a more tidy and less cluttered as well as making things so much more manageable.
Mailable classes are required to extend the base Anddye\Mailer\Mailable
class;
Now in your controller or route, you set the recipients address and name, passing
just a single argument into the sendMessage
method - a new instance of the mailable
class;
Methods
Method | Description |
---|---|
attachFile(string $path) | Path to a file to set as an attachment. |
detachFile(string $path) | Path to a file to remove as an attachment. |
setBcc(string $address, string $name = '') | Set the Bcc of the message. |
setBody($body) | Set the body of the message. |
setCc(string $address, string $name = '') | Set the Cc of the message |
setDate(DateTimeInterface $dateTime) | Set the date at which this message was created. |
setFrom(string $address, string $name = '') | Set the sender of the message. |
setReplyTo(string $address, string $name = '') | Set the ReplyTo of the message. |
setPriority(int $priority) | Set the priority of the message. |
setSubject(string $subject) | Set the subject of the message. |
setTo(string $address, string $name = '') | Set the recipent of the message. |
Support
If you are having general issues with this library, then please feel free to contact me on Twitter.
If you believe you have found an issue, please report it using the issue tracker, or better yet, fork the repository and submit a pull request.
If you're using this package, I'd love to hear your thoughts!
Useful Links
All versions of slim3-mailer with dependencies
slim/slim Version ^3.0
swiftmailer/swiftmailer Version ^6.0
slim/twig-view Version ^2.0