25th/zf2-exception-mailer-module

Zend Framework 2 Module that provides a Simple Exception Mailer functionality

ZendFramework 2 Exception Mailer Module

A simple ZF2 Module for sending Mails if Exceptions happen on production systems. In it's simplest configuration it just sends the stack trace of the Exception. But you can also render views and send html mails instead., _(*1)

Installation

Installation of this module uses composer. For composer documentation, please refer to getcomposer.org., _(*2)

php composer.phar require 25th/zf2-exception-mailer-module
# (When asked for a version, type `0.*`)

Then add ExceptionMailer to your config/application.config.php., _(*3)

Installation without composer is not officially supported and requires you to manually install all dependencies that are listed in composer.json, _(*4)

Configuration

To configure the Mailer use your application config:, _(*5)

<?php
return array(
    // Exception Stuff
    'exception_mailer' => array(
        // Mail
        'send' => true,
        'sender' => 'your-sender-address@mail.com',
        'recipients' => array(
            'your-recipient-address@mail.com',
        ),
        'subject' => 'My Exception Mailer',
        'exceptionInSubject' => false

        // HTML Templates
        'useTemplate' => false,
        'template' => 'error/index'
    ),
);

Ignore Exceptions

It's also possible to ignore certain Exceptions. Just let them implement the IgnoreExceptionInterface and they will be ignored., _(*6)

HTML Emails

For HTML Emails set useTemplate to true and use the template parameter for your template configuration., _(*7)

If you want to use a different template f.e. "error/mail" you also have to define it in the view_manager => template_map array with the correct position to it, _(*8)

<?php
return array(
    ...
    'view_manager' => array(
        'template_map'        => array(
            ...
            'error/mail'              => __DIR__ . '/../view/error/mail.phtml', // Exception_Mailer
            ...
        ),
    ),
    ...
);