PHPackages                             descubraomundo/notifymehq-mail - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. descubraomundo/notifymehq-mail

ActiveLibrary[Mail & Notifications](/categories/mail)

descubraomundo/notifymehq-mail
==============================

Provides a mail gateway for notifyme

v2.0.4(9y ago)31.3kMITPHPPHP >=5.5.9

Since Nov 16Pushed 9y ago1 watchersCompare

[ Source](https://github.com/descubraomundo/notifymehq-mail)[ Packagist](https://packagist.org/packages/descubraomundo/notifymehq-mail)[ RSS](/packages/descubraomundo-notifymehq-mail/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (6)Dependencies (6)Versions (5)Used By (0)

[![Build Status](https://camo.githubusercontent.com/13dd36ef5151c7dc8af7539f4db73cc196aab7c51ccfce2b285aac3eb9307b91/68747470733a2f2f7472617669732d63692e6f72672f64657363756272616f6d756e646f2f6e6f746966796d6568712d6d61696c2e737667)](https://travis-ci.org/descubraomundo/notifymehq-mail)

NotifyMeHQ Mail
===============

[](#notifymehq-mail)

An **UNOFFICIAL** Mail gateway for NotifyMeHQ as they "*intentionally removed mail support*" for NotifyMeHQ.

If you want to keep the default contract of NotifyMeHQ `public function notify($to, $message);` with both parameters as a string, the expected behavior is:

1. The recipient of the email notificafion will not have his name on the recipients information, it will only be the email.
2. The subject of the email will be the first 75 characters of the `$message` content, but all HTML tags will be removed.
3. The body of the email, will be the content of the `$message` it self with all the HTML tags. \* If the body of the email, is a HTML, it will automatically create a Plain text of it, formated just like the HTML, so it will reduce the SPAM score for that email. \* If the body has no HTML, it will be sent as plain text.

Otherwise you can send the `$message` variable as an array with the desired configurations below.

Configuration
-------------

[](#configuration)

Here is the list of all available configurations that you can provide for you notifierFactory and for your notification.

### Notifier

[](#notifier)

ConfigurationRequiredDescriptionhost**true**Specify your SMTP Server Host.port**true**Specify your SMTP Server Port, check with your host. Eg: *25* or *465* or *2525*.encryption**true**Specify your SMTP Server Encryption, check with your host. Eg: *tls* or *ssl*.username**true**Specify your SMTP Server Username.password**true**Specify your SMTP Server Password.subject*optional*Specifies the subject line that is displayed in the recipients' mail client.cc*optional*Specifies the addresses of recipients who will be copied in on the message.bcc*optional*Specifies the addresses of recipients who the message will be blind-copied to. Other recipients will not be aware of these copies.replyTo*optional*Specifies the address where replies are sent to.from*optional*Specifies the sender address if you want to overwrite the value set on the configuration properties.contentType*optional*Specifies the format of the message (usually text/plain or text/html).date*optional*Specifies the unix time stamp date at which the message was sent.returnPath*optional*Specifies where bounces should go (Swift Mailer reads this for other uses).priority*optional*Specifies the email priority. Setting the priority will not change the way your email is sent It is purely an indicative setting for the recipient.### Notification

[](#notification)

If you provide any of the configuration bellow, they will overwrite the default configuration provided for the notifierFactory.

ConfigurationRequiredDescriptionsubject**true**Specifies the subject line that is displayed in the recipients' mail client.body**true**Specifies the body of the email that the recipient will receive.cc*optional*Specifies the addresses of recipients who will be copied in on the message.bcc*optional*Specifies the addresses of recipients who the message will be blind-copied to. Other recipients will not be aware of these copies.replyTo*optional*Specifies the address where replies are sent to.from*optional*Specifies the sender address if you want to overwrite the value set on the configuration properties.contentType*optional*Specifies the format of the message (usually text/plain or text/html).id*optional*Identifies this message with a unique ID, usually containing the domain name and time generated.date*optional*Specifies the unix time stamp date at which the message was sent.returnPath*optional*Specifies where bounces should go (Swift Mailer reads this for other uses).priority*optional*Specifies the email priority. Setting the priority will not change the way your email is sent It is purely an indicative setting for the recipient.### Advanced

[](#advanced)

#### body

[](#body)

For the body value you can provide both versions(HTML and plain text):

```
    'body'    => [
        'html'  => 'My amazing body',
        'plain' => 'My amazing body'
    ],
```

Or you can provide only one version, and we will detect automatically if is HTML or plain text and configure correctly:

```
    'body'    => 'My amazing body'  // It will be sent as HTML

```

OR

```
    'body'    => 'My amazing body'           // It will be sent as plain text

```

#### from, to, cc, bcc, replyTo

[](#from-to-cc-bcc-replyto)

For all email recipients / sender configuration you can provide them in two variants:

*Email and Name* (As an array)

```
    'from|to|cc|bcc|replyTo' => ['email@example.com', 'Example Name'],

```

*Email Only* (As a string)

```
    'from|to|cc|bcc|replyTo' => 'email@example.com',

```

#### priority

[](#priority)

This configuration takes an integer value between 1 and 5:

- Highest (1)
- High (2)
- Normal (3)
- Low (4)
- Lowest (5)

Example
-------

[](#example)

```