Download the PHP package descubraomundo/notifymehq-mail without Composer
On this page you can find all versions of the php package descubraomundo/notifymehq-mail. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download descubraomundo/notifymehq-mail
More information about descubraomundo/notifymehq-mail
Files in descubraomundo/notifymehq-mail
Package notifymehq-mail
Short Description Provides a mail gateway for notifyme
License MIT
Informations about the package 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:
- The recipient of the email notificafion will not have his name on the recipients information, it will only be the email.
- The subject of the email will be the first 75 characters of the
$messagecontent, but all HTML tags will be removed. - The body of the email, will be the content of the
$messageit 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
Here is the list of all available configurations that you can provide for you notifierFactory and for your notification.
Notifier
| Configuration | Required | Description |
|---|---|---|
| host | 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
If you provide any of the configuration bellow, they will overwrite the default configuration provided for the notifierFactory.
| Configuration | Required | Description |
|---|---|---|
| subject | 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
body
For the body value you can provide both versions(HTML and plain text):
Or you can provide only one version, and we will detect automatically if is HTML or plain text and configure correctly:
OR
from, to, cc, bcc, replyTo
For all email recipients / sender configuration you can provide them in two variants:
Email and Name (As an array)
Email Only (As a string)
priority
This configuration takes an integer value between 1 and 5:
- Highest (1)
- High (2)
- Normal (3)
- Low (4)
- Lowest (5)
Example
Todo
- [ ] Add tests
License
NotifyMe is licensed under The MIT License (MIT).
All versions of notifymehq-mail with dependencies
graham-campbell/manager Version ~2.0
swiftmailer/swiftmailer Version ~5.4
soundasleep/html2text Version ~0.2
illuminate/contracts Version ~5.0
illuminate/support Version ~5.0