ebittleman/mailgun-zf2

ZF2 Wrapper for Mailgun

1.0.4 2015-06-08 15:04 UTC

Requires

• php: >=5.3.3
• mailgun/mailgun-php: ~1.7.2
• zendframework/zendframework: ~2.3

Requires (Dev)

• phpunit/phpunit: ^4.6

The MIT License (MIT)

• framework
• zf2
• mailgun

README

This is a super new library and no guarantees are made on anything. It pretty much just hooks mailgun/mailgun-php directly into Zend Framework 2 Have fun.

Installation

composer require ebittleman/mailgun-zf2

Module Config

This module is pretty config light, just need to know your api key and domain for Mailgun. BEWARE: do not commit your creds unencrypted to public repos!!!!

return array(
    'mailgun' => array(
        'apiKey' => 'YOUR_MAILGUN_APIKEY',
        'domain' => 'YOUR_MAILGUN_DOMAIN',
    ),
);

Application Config

You will need to enable the module by adding it to your application config

return array(
    'modules' => array(
        ...YOUR MODULES...,
        'MailgunZf2'
    ),
    'module_listener_options' => array(
        'config_glob_paths' => array(
            ...YOUR CONFIG PATHS...
        ),
        'module_paths' => array(
            ...YOUR MODULES PATHS...
        )
    )
);

Super Basic Usage

So the basic idea here is that the MessageViewModel is pretty much just an view adapter wrapped around Mailgun\MessagesMessageBuilder and it gets passed to a controller plugin that will prepare that message to be sent at ZF2's MvcEvent::EVENT_FINSH event

namespace MailgunZf2\Controller;

use MailgunZf2\View\Model\MessageViewModel;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;

class IndexController extends AbstractActionController
{

    const HTMLTEMPLATE = 'emails/html.phtml';

    const TEXTTEMPLATE = 'emails/text.phtml';

    const FIRSTNAME = 'Chump';

    const SUBJECT = 'Welcome to spam town';

    public function indexAction()
    {
        $message = new MessageViewModel(
            static::HTMLTEMPLATE,
            static::TEXTTEMPLATE,
            array(
                'firstName' => 'Bob',
                'subject' => 'Howdy There Bob'
            )
        );
        
        $message->addToRecipient('[e-mail]');
        $message->setFromAddress('[e-mail]');

        $this->mailgun($message);

        return new ViewModel();
    }
}