slm/mail

Integration of various email service providers in the Zend Framework Zend\Mail

Tuesday, February 27, 2018
by juriansluiman
Repository
13 Watchers
101 Stars
184,681 Installations

PHP
7 Dependents
1 Suggesters
40 Forks
15 Open issues
23 Versions
5 % Grown

The README.md

SlmMail

Warning This package relies on slm, which is abandoned and will receive no further development. For that reason, we don't recommend starting any project with this package. Instead take a look at https://github.com/omnimail/omnimail or use symfony/mailer with a 3rd Party Transport., _(*1)

, _(*2)

SlmMail is a module that integrates with various third-parties API to send mails. Integration is provided with the API of those services. It does not handle SMTP., _(*3)

Here are the currently supported services:, _(*4)

Elastic Email (complete)
Mailgun (complete)
Postmark (complete)
Postage (complete)
SendGrid (nearly complete)
SparkPost (nearly complete)
Amazon SES (nearly complete, attachments are missing)
Mandrill (complete, but please don't use this party, as Mailchimp / Mandrill do not actively maintain this service)

Installation

First install the repo:, _(*5)

composer require slm/mail, _(*6)

For Laminas MVC add SlmMail in your application.config.php file.
For Mezzio it should prompt whether we want to autoconfigure. Accept this.

In order to use a mail service, you now need to configure it. We have provided a sample configuration file per mail server., _(*7)

Copy the sample configuration file to your autoload directory. For example for Mandrill one would use, _(*8)

cp vendor/slm/mail/config/slm_mail.mandrill.local.php.dist config/autoload/slm_mail.mandrill.local.php, _(*9)

Please tweak the dummy contents in this file. This file will contain the credentials., _(*10)

Usage

One can now fetch the dependencies from the service manager. And now compose a message:, _(*11)

$message = new \Laminas\Mail\Message();
$message
    ->setTo('send@to')
    ->setFrom('send@by')
    ->setSubject('Subject')
    ->setBody('Contents');

$mandrillService = $container->get(\SlmMail\Service\MandrillService::class);
$mandrillService->send($message);
```` 

Documentation
-------------

Documentation for SlmMail is splitted for each provider:

* [Elastic Email](/docs/ElasticEmail.md)
* [Mailgun](/docs/Mailgun.md)
* [Mandrill](/docs/Mandrill.md)
* [Postage](/docs/Postage.md)
* [Postmark](/docs/Postmark.md)
* [SendGrid](/docs/SendGrid.md)
* [SparkPost](/docs/SparkPost.md)
* [Amazon SES](/docs/Ses.md)

Cook-book
---------

### How to send an HTML email ?

Every email providers used in SlmMail allow to send HTML emails. However, by default, if you set the mail's content
using the `setBody` content, this content will be considered as the plain text version as shown below:

```php
$message = new \Laminas\Mail\Message();

// This will be considered as plain text message, even if the string is valid HTML code
$message->setBody('Hello world');

To send a HTML version, you must specify the body as a MimeMessage, and add the HTML version as a MIME part, as shown below:, _(*12)

$message = new \Laminas\Mail\Message();

$htmlPart = new \Laminas\Mime\Part('<html><body>

Hello world

</body></html>');
$htmlPart->type = "text/html";

$textPart = new \Laminas\Mime\Part('Hello world');
$textPart->type = "text/plain";

$body = new \Laminas\Mime\Message();
$body->setParts(array($textPart, $htmlPart));

$message->setBody($body);

For accessibility purposes, you should always provide both a text and HTML version of your mails., _(*13)

`multipart/alternative` emails with attachments

The correct way to compose an email message that contains text, html and attachments is to create a multipart/alternative part containing the text and html parts, followed by one or more parts for the attachments. See the Laminas Documentation for a full example., _(*14)

How to configure HttpClient with http_options and http_adapter

By default the adapter is Laminas\Http\Client\Adapter\Socket but you can override it with other adapter like this in your slm_mail.*.local.php, _(*15)

'slm_mail' => array(
    // Here your email service provider options

    'http_adapter' => 'Laminas\Http\Client\Adapter\Proxy' // for example
)

If you want to change some options of your adapter please refer to you adapter class in var $config here and override these in your slm_mail.*.local.php like this :, _(*16)

'slm_mail' => array(
    // Here your email service provider options

    // example for Socket adapter
    'http_options' => array(
        'sslverifypeer' => false,
        'persistent' => true,
    ),
)

Which provider should I choose?

We won't answer you :-)! Each provider has their own set of features. You should carefully read each website to discover which one suits your needs best., _(*17)

Who to thank?

Jurian Sluiman and Michaël Gallego did the initial work on creating this repo, and maintained it for a long time., _(*18)

Currently it is maintained by:, _(*19)

Roel van Duijnhoven

The Versions

27/02 2018

dev-master

9999999-dev https://github.com/juriansluiman/SlmMail

Integration of various email service providers in the Zend Framework Zend\Mail

library mail

Integration of various email service providers in the Zend Framework Zend\Mail

slm/mail

The README.md

SlmMail

Installation

Usage

Hello world

multipart/alternative emails with attachments

How to configure HttpClient with http_options and http_adapter

Which provider should I choose?

Who to thank?

The Versions

dev-master

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v2.1.2

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v2.1.1

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v2.1.0

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v2.0.0

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.6.0

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.5.3

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.5.2

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.5.1

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.5.0

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.4.1

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.4.0

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.3.2

The Requires

The Development Requires

by Michaël Gallego

by Jurian Sluiman

v1.3.1

The Requires

`multipart/alternative` emails with attachments