slick/mail

Email plugin provides generalized functionality to compose and send both text and MIME-compliant multipart email messages.

Slick Mail

, _(*1)

Email plugin provides generalized functionality to compose and send both text and MIME-compliant multi-part e-mail messages., _(*2)

This package is compliant with PSR-2 code standards and PSR-4 autoload standards. It also applies the semantic version 2.0.0 specification., _(*3)

Features, _(*4)

• Easy mail transport creation (SMTP, PHP mail())
• Uses Twig for a robust template engine
• Multi-Part e-mail messages

Installation, _(*5)

To use E-Mail plugin in your project just run the following command:, _(*6)

$ composer require slick/mail

Quick Start, _(*7)

Create a message:, _(*8)

``` php use Slick\Mail\Message; use Slick\Mail\MessageBody;, <sub>(*9)</sub>

$message = new Message(); $message->setFrom('some@from.address', 'Slick Mail') ->addTo('you@example.com') ->setSubject('Log message');, <sub>(*10)</sub>

$body = new MessageBody( 'mail/template.twig', ['foo' => $foo, 'bar' => 'baz'] );
$message->setBody($body);, <sub>(*11)</sub>

If you need to send a multi-part e-mail with text and HTML or embedding images in it
for example, you can do like this:

``` php
use Slick\Mail\Mime;
use Slick\Mail\Mime\MimeMessage;
use Slick\Mail\Mime\Part as MimePart;

$text = new MimePart('mail/template.twig', ['foo' => $foo, 'bar' => 'baz']);
$text->type = "text/plain";

$image = new MimePart('image.jpg');
$image->type = "image/jpeg";
$image->id = "image";
$image->encoding = Mime::ENCODING_BASE64;

$html = new MimePart('mail/template.html.twig', ['foo' => $foo, 'bar' => 'baz']);
$html->type = "text/html";

$message = new MimeMessage();
$message->parts()
    ->add($text)
    ->add($image)
    ->add($html)
;

As you can see it very easy to compose an e-mail message. Now you need to send it! Lets see:, <sub>(*12)</sub>

``` php use Slick\Mail\Transport\SmtpTransport;, <sub>(*13)</sub>

$transport = new SmtpTransport([ 'options' => [ 'name' => 'localhost.localdomain', 'host' => '127.0.0.1', 'port' => 25, ] ]);, <sub>(*14)</sub>

$transport->send($message);, <sub>(*15)</sub>

```, <sub>(*16)</sub>

For a complete documentation on the SMTP transport object and options, as this is an extension to the Zend\Mail\Transport\Smtp class, you can go to the Zend/Mail/transport manual website., <sub>(*17)</sub>

Contribute, <sub>(*18)</sub>

• Issue Tracker: https://github.com/slickframework/mail/issues
• Source Code: https://github.com/slickframework/mail

Support, <sub>(*19)</sub>

If you are having issues, please let us know., <sub>(*20)</sub>

License, <sub>(*21)</sub>

The project is licensed under the MIT License (MIT), <sub>(*22)</sub>