laravel-mail/README.md

# BMail

The BMail package allows you to send email templates on Laravel to the Bluescale API.

## Installation

First in your composer.json, add :

```bash
"require": {
        "bluescale/laravel-bmail": "dev-master"
}
```

and

```bash
"repositories": [
        {
            "type": "vcs",
            "url": "git@git.bluesquare.io:bluescale/laravel-bmail.git"
        }
]
```

Next update your package :

```bash
composer update bluescale/laravel-bmail
```

Then publish the assets from your provider :

```bash
php artisan vendor:publish
```

Finally add your API key in the .env :

```bash
BMAIL_API_KEY=your_key
BMAIL_API_URL=the_api_url
```

## Usage

```bash
$template = (new BMailTemplate("** template_id **"))
    ->sender("john.doe@gmail.com", 'John OPTIONNAL') OPTIONNAL
    ->replyTo("jean.grey@gmail.com", 'Jean OPTIONNAL') OPTIONNAL
    ->recipients([
        [
            'elvis@gmail.com', [
                'name' => 'Elvis' OPTIONNAL,
                'parameters' => ['key' => 'value'] OPTIONNAL
            ]
        ],
        [
            'robert@gmail.com'
        ]
    ])
    ->addRecipient('edward@gmail.com')
    ->parameters(['key1' => 'value1', 'key2' => 'value2'])
    ->addParameter('key', 'value');
```

```bash
return (new BMailApi(config('bmail.api_key')))->send($template);
```