laravel-mandrillhooks

KO | EN

gitlite — search

#javascript #react #go #golang #rust #deep-learning #macos #java #cli #awesome-list #vue #ios #mcp #open-source

laravel-mandrillhooks

(★ 63)

A simple Mandrill webhook base controller for catching bounced, rejected, etc mail events.

laravel-mandrillhooks Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel Mandrill Webhook Controller
[![Latest Version](https://img.shields.io/github/release/eventhomes/laravel-mandrillhooks.svg?style=flat-square)](https://github.com/eventhomes/laravel-mandrillhooks/releases)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/eventhomes/laravel-mandrillhooks/develop/LICENSE.md)
[![Total Downloads](https://img.shields.io/packagist/dt/eventhomes/laravel-mandrillhooks.svg?style=flat-square)](https://packagist.org/packages/eventhomes/laravel-mandrillhooks)

A simple Mandrill webhook controller to help with email events. Useful for notifying users that you cannot reach them via email inside your application. Compatible with Laravel 5+ and Lumen 5+.

## Installation
```composer require eventhomes/laravel-mandrillhooks```

## Basic Usage

1) Create a controller that extends MandrillWebhookController as follows. You can then handle any Mandrillapp webhook event.
```php
use EventHomes\Api\Webhooks\MandrillWebhookController;

class MyController extends MandrillWebhookController {

/**
     * Handle a hard bounced email
     *
     * @param $payload
     */
    public function handleHardBounce($payload)
    {
        $email = $payload['msg']['email'];
    }

/**
     * Handle a rejected email
     *
     * @param $payload
     */
    public function handleReject($payload)
    {
        $email = $payload['msg']['email'];
    }
}
```

2) Create the route to handle the webhook. In your routes.php file add the following.
```php
post('mandrill-webhook', ['as' => 'mandrill.webhook', 'uses' => 'MandrillController@handleWebHook']);
```
3) [Exclude your route from CSRF protection](https://laravel.com/docs/5.4/csrf#csrf-excluding-uris) so it will not fail.

4) Make sure you add your webhook in Mandrill to point to your route. You can do this here: https://mandrillapp.com/settings/webhooks

## (Optional) Webhook Authentication
If you would like to increase the security of the webhooks. Add the *MandrillWebhookServiceProvider* provider to the providers array in config/app.php

```php
'providers' => [
  ...
  EventHomes\Api\Webhooks\MandrillWebhookServiceProvider::class,
],
```

Next, publish the configuration via
```php
php artisan vendor:publish --provider="EventHomes\Api\Webhooks\MandrillWebhookServiceProvider"
```
Simply add your Mandrill webhook key in the config file and requests will be authenticated.

## Webhook Events
[Webhook event types](https://mandrill.zendesk.com/hc/en-us/articles/205583217-Introduction-to-Webhooks#event-types):

## Contributors
Special thanks to @rafaelbeckel and @minioak!

laravel-mandrillhooks

laravel-mandrillhooks Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

laravel-mandrillhooks

laravel-mandrillhooks Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README