Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mailjet/mailjetbundle

Symfony bundle for Mailjet API V3
https://github.com/mailjet/mailjetbundle

bundle email mailjet mailjet-api packagist php symfony symfony-bundle symfony2 symfony3 transactional-emails

Last synced: 6 days ago
JSON representation

Symfony bundle for Mailjet API V3

Awesome Lists containing this project

README

        

# Mailjet Bundle

[![Build Status](https://travis-ci.org/mailjet/mailjetBundle.svg?branch=master)](https://travis-ci.org/mailjet/mailjetBundle)
[![Packagist](https://img.shields.io/packagist/v/mailjet/mailjet-bundle.svg)](https://packagist.org/packages/mailjet/mailjet-bundle)
[![Packagist](https://img.shields.io/packagist/dt/mailjet/mailjet-bundle.svg)](https://packagist.org/packages/mailjet/mailjet-bundle)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mailjet/mailjetBundle/blob/master/LICENSE.md)
[![Documentation](https://img.shields.io/badge/documentation-gh--pages-blue.svg)](https://mailjet.github.io/mailjetBundle/)

Symfony bundle for handling Mailjet API V3 using this wrapper:

## Features

* [x] Retrieve [\Mailjet\Client](https://github.com/mailjet/mailjet-apiv3-php) to make custom Mailjet API V3 requests
* [x] [SwiftMailer Transport integration](https://github.com/mailjet/MailjetSwiftMailer)
* [x] Synchronize Contact Metadata (Contact Properties) with your config
* [x] Synchronize your user with Mailjet contact list
* [x] Use your own userProvider (basic `FosContactProvider` included to interface with FosUserBundle)
* [x] Use lifecycle event to subscribe/unsubscribe/update/delete/changeMail user from a contact List
* [x] Register Event API - real time notifications (webhook)

## Setup

Add `Mailjet\MailjetBundle\MailjetBundle` to your `bundles.php`:

```php
$bundles = [
// ...
Mailjet\MailjetBundle\MailjetBundle::class => ['all' => true]
];
```

## Minimal Configuration

In your `config.yml` add:

```yaml
mailjet:
api_key: "%mailjet.api_key%"
secret_key: "%mailjet.secret_key%"
```

Add bundle to your project:

```bash
composer require mailjet/mailjet-bundle
```

## ToDo

* More unit tests
* Functionnal tests
* Other features like Campaigns, stats, ...

## Contributing

If you want to contribute to this project, look at [over here](CONTRIBUTING.md)