README

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 $message content, but all HTML tags will be removed.
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

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

Notifier

Notification

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

Advanced

body

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

    'body'    => [
        'html'  => 'My <em>amazing</em> 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 <em>amazing</em> body'  // It will be sent as HTML

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

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

This configuration takes an integer value between 1 and 5:

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

Example

<?php
    // Create a factory for notifications.
    $notifierFactory = new NotifyMeHQ\NotifyMe\NotifyMeFactory();

    // Create the new notification for mail.
    $mailNotifier = $notifierFactory->make([
      // Specify that we will use mail.
      'driver' => 'mail',
      // Specify your SMTP Server Host.
      'host' => '',
      // Specify your SMTP Server Port, check with your host. Eg: 25 or 465 or 2525.
      'port' => 25,
      // Specify your SMTP Server Username.
      'username' => '',
      // Specify your SMTP Server Password.
      'password' => '',
      // Specify your Sender details. It can be a simple email, or a email with a name.
      'from' => ['from@example.com','Example Sender'], // Email & Name
    ]);

    /**
     * RECIPIENTS:
     */
    $recipient = ['recipient@example.com', 'Recipient Name'];

    /**
     * EMAIL
     */
    $email = [
        // Specifies the subject line that is displayed in the recipients' mail client
        'subject' => 'Test',
        // Specifies the body of the email that the recipient will receive.
        'body'    => [
            'html'  => 'My <em>amazing</em> body',
            'plain' => 'My amazing body'
        ],
        // Specifies the addresses of recipients who will be copied in on the message
        'cc' => ['cc@email.com', 'CC Name'],
        // Specifies the addresses of recipients who the message will be blind-copied to. Other recipients will not be aware of these copies.
        'bcc' => ['bcc@email.com', 'BCC Name'],
        // Specifies the address where replies are sent to
        'replyTo' => ['replyto@email.com', 'Reply To Name'],
        // Specifies the sender address if you want to overwrite the value set on the configuration properties.
        'from' => ['otherFrom@email.com', 'Other Sender Name'],

        /**
         * ADVANCED OPTIONS
         */
        // Specifies the format of the message (usually text/plain or text/html)
        'contentType' => 'text/html',
        // Specifies where bounces should go (Swift Mailer reads this for other uses)
        'returnPath' => 'bounces@email.com',
        // Specifies the email priority.
        'priority' => '2', // Indicates "High" priority.
    ];

    /* @var \NotifyMeHQ\Contracts\ResponseInterface $response */
    $response =  $mailNotifier->notify($recipient, $email);

    echo $response->isSent() ? 'Message sent' : 'Message going nowhere';

Todo

Add tests

License

NotifyMe is licensed under The MIT License (MIT).

descubraomundo / notifymehq-mail

Maintainers

Details