ro9ueadmin / super-mailer Goto Github PK

Super Mailer

A convenient package for sending mass html emails.

What does it do?

Instead of writing your own scripts to send emails, you can quickly configure the package with your SMTP details, create your message body and subject templates, send the email and be done with it! It's that simple!

Installation

Clone the repository and use composer to install the dependencies.

composer install

Then include vendor/autoload.php in your PHP file to start using the Masnun\SuperMailer\SuperMailer class.

Usage

The Masnun\SuperMailer\SuperMailer class constructor has the following paramters:

• SMTP Host
• SMTP Port
• SMTP Username
• SMTP Password
• Subject Template (String)
• Path to message body template file
• Your Name
• Your Email address

Your name and email address is used as the "From" header of the email.

The object instance has a method sendEmail that we use to send the emails to our recipients. The method takes these arguments:

• Name of the recipient
• Email address of the recipient
• The array of data that will be passed to the body and subject templates

Code Sample

<?php
// File: config.php

$smtp = [
    'host' => 'smtp.mandrillapp.com',
    'port' => 587,
    'username' => '[email protected]',
    'password' => 't4VTk0BdNPC7I9-GRY'
];

<?php
// File: index.php

require_once 'vendor/autoload.php';
require_once 'config.php';

use Masnun\SuperMailer\SuperMailer;

$mailer = new SuperMailer(
    // smtp data
    $smtp['host'],
    $smtp['port'],
    $smtp['username'],
    $smtp['password'],

    // Subject template
    'Hello {{name}}!',

    // Message body template
    'invitation.html.twig',

    //Sender details
    "Abu Ashraf Masnun",
    "[email protected]"
);


$sampleUsersArray = [

    [
        'name' => "Masnun",
        'email' => '[email protected]',
        'token' => '2eff42576ee8fc0dccdd38c0108fe8af'
    ],

    [
        'name' => 'The Doctor',
        'email' => '[email protected]',
        'token' => '2aa5a1d13d655a57dbc0e40b5b50365c'
    ]
];


foreach ($sampleUsersArray as $user)
{
    $mailer->sendEmail($user['name'], $user['email'], $user);
}

And here's the template:

Hello {{ name }}, <br/><br/>

Welcome to our super cool event of the year! Your email address is: {{ email }}
and your token is {{ token }}. <br/><br/>

-- Organizers