astonishdesign/mandrill-bundle

Symfony HipMandrillBundle Fork

Maintainers

Details

github.com/astonishdesign/HipMandrillBundle

Homepage

Source

Installs: 21

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 51

Type:symfony-bundle

v1.0.3 2015-01-09 08:36 UTC

Requires

MIT f379f2987f09a08ac6a7c930bffd28e55d316adf

emailmandrillmessagestransaction mailtransactional

This package is not auto-updated.

Last update: 2024-04-13 14:13:12 UTC

README

Send transactional mail through mandrill.com. This bundle provides an easy api for Symfony2 Projects.

All settings inside message class represent attributes of Mandrill's API. Please refer to their API documentation for Details:

https://mandrillapp.com/api/docs/messages.html

Prerequisites

Before you're able to use this bundle you must sign up with Mandrill.

http://mandrill.com

Mandrill is a great way to send your transactional emails and provides detailed advances reports.

Mandrill is free for limited number of email per day, please read through pricing section on the website for more information:

http://mandrill.com/pricing/

Installation

Add the bundle to your composer.json

# composer.json
{
 "require": {
     "hipaway-travel/mandrill-bundle": "dev-master",
 }
}

Run composer install

php ./composer.phar install

Enable the bundle in the kernel

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Hip\MandrillBundle\HipMandrillBundle(),
    );
}

Configuration

Add configuration to config.yml.

Log in to Mandrill and go to "Settings" -> "SMTP and API Credentials". Create an API Key and use it in your Symfony2 Configuration.

# config.yml

hip_mandrill:
    api_key: xxxxx
    disable_delivery: true # useful for dev/test environment. Default value is 'false'
    default:
        sender: info@example.com
        sender_name: John Doe
        subaccount: Project # Optionally define a subaccount to use

To override the FOSUserBundle Mailer:

# config.yml
fos_user:
    # ...
    service:
        mailer: hip_mandrill.fosuser.mailer

Now you're all set, send your first transactional mails:

Use

Simple controller Example:

<?php

// src/Hip/ExampleBundle/Controller/ExampleController.php
namespace Hip\ExampleBundle\Controller;

use Symfony\Component\HttpFoundation\Response;

use Hip\MandrillBundle\Message;
use Hip\MandrillBundle\Dispatcher;

class ExampleController
{
    public function indexAction()
    {
        $dispatcher = $this->get('hip_mandrill.dispatcher');

        $message = new Message();

        $message
            ->setFromEmail('mail@example.com')
            ->setFromName('Customer Care')
            ->addTo('max.customer@email.com')
            ->setSubject('Some Subject')
            ->setHtml('<html><body><h1>Some Content</h1></body></html>')
            ->setSubaccount('Project');

        $result = $dispatcher->send($message);

        return new Response('<pre>' . print_r($result, true) . '</pre>');

    }

}