snowcap/mailjet-bundle

Mailjet wrapper for Symfony2

Installs: 3 264

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 4

Forks: 0

Open Issues: 0

Type:symfony-bundle

dev-master 2014-09-04 17:00 UTC

This package is not auto-updated.

Last update: 2024-12-21 15:37:59 UTC


README

The Snowcap Mailjet Bundle is a bundle used at Snowcap to help us with the Mailjet API:

It includes an refactored version of Mailjet API client (found on https://www.mailjet.com/plugin/php-mailjet.class.php) with:

  • PSR-0 standards
  • New constants
  • A bundle configuration

Prerequisites

This version of the bundle requires Symfony 2.1+.

Installation

Download SnowcapMailjetBundle using composer

Add SnowcapCoreBundle in your composer.json:

{
    "require": {
        "snowcap/mailjet-bundle": "*"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update snowcap/mailjet-bundle

Composer will install the bundle to your project's vendor/snowcap directory.

Enable the Bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Snowcap\MailjetBundle\SnowcapMailjetBundle(),
    );
}

Configure Mailjet

In your config.yml:

snowcap_mailjet:
    api_key: %mailjet_api_key%
    secret_key: %mailjet_secret_key%

An optional parameter "debug" is available (0 by default). See Mailjet's doc for more information.

Usage

The API is available with the "snowcap_mailjet" service. In your controller (or elsewhere):

public function newsletterAction()
{
    // Get Mailjet client
    $client = $this->get('snowcap_mailjet');
    
    // Add an email to a mailing list
    $client->listsAddcontact(
        array(
            'contact' => 'someone@email.com',
            'id'      => 'your-list-id',
            'force'   => true,
            'method'  => 'POST'
        )
    );
}