slick / mail
Email plugin provides generalized functionality to compose and send both text and MIME-compliant multipart email messages.
Installs: 1 141
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=5.5
- ext-mcrypt: *
- slick/common: ^1.2
- slick/template: ^1.2
- zendframework/zend-crypt: ^2.6
- zendframework/zend-mail: ^2.7
- zendframework/zend-mime: ^2.6
Requires (Dev)
- behat/behat: ^3.0.4
- guzzlehttp/guzzle: ^6.2
- phpunit/php-code-coverage: ^2
- phpunit/phpunit: ^4
- scrutinizer/ocular: ~1.1
This package is auto-updated.
Last update: 2024-10-20 10:47:10 UTC
README
Email plugin provides generalized functionality to compose and send both text and MIME-compliant multi-part e-mail messages.
This package is compliant with PSR-2 code standards and PSR-4 autoload standards. It also applies the semantic version 2.0.0 specification.
Features
- Easy mail transport creation (SMTP, PHP mail())
- Uses Twig for a robust template engine
- Multi-Part e-mail messages
Installation
To use E-Mail plugin in your project just run the following command:
$ composer require slick/mail
Quick Start
Create a message:
use Slick\Mail\Message; use Slick\Mail\MessageBody; $message = new Message(); $message->setFrom('some@from.address', 'Slick Mail') ->addTo('you@example.com') ->setSubject('Log message'); $body = new MessageBody( 'mail/template.twig', ['foo' => $foo, 'bar' => 'baz'] ); $message->setBody($body);
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:
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:
use Slick\Mail\Transport\SmtpTransport; $transport = new SmtpTransport([ 'options' => [ 'name' => 'localhost.localdomain', 'host' => '127.0.0.1', 'port' => 25, ] ]); $transport->send($message);
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.
Contribute
- Issue Tracker: https://github.com/slickframework/mail/issues
- Source Code: https://github.com/slickframework/mail
Support
If you are having issues, please let us know.
License
The project is licensed under the MIT License (MIT)