README

Citco Mailer is developed by Creative Investments Technologies as an extension to Mailer package provided by Laravel framework

About

Citco Mailer adds some unique features to original Mailer provided by Laravel framework. These features include:

Adding custom headers to outgoing mails for better tracking of bounced mails
Log all outgoing mails by auto forwarding them to a special log email address
More help on email tracking by generating a reply-path alias for each receiver, based on receiver's email address

Installation

Composer

From the Command Line:

composer require citco/mailer:dev-master

In your composer.json:

{
    "require": {
        "citco/mailer": "dev-master"
    }
}

After updating composer, add the MailerServiceProvider to the providers array in app/config/app.php

    'Citco\Mailer\MailerServiceProvider',

You also need to publish configurations for this package by executing this artisan command:

php artisan config:publish citco/mailer

This makes configuration options available in app/config/packages/citco/mailer/config.php .
These configuration include:
site.id: Used to set X-Site-ID header parameter in sent mails. noreply.address and noreply.name: Address and name used as sender to send emails from.
log.enabled: If set to true, a copy of all outgoing emails will also be sent to a special log.address.
log.address and log.name: Log email address and name, used to send all outgoing mails if log.enabled is set to true.
dev.address and dev.name: Address and name of development mail account. This is useful while developing your application. If the application is running on local or dev environment (detected by Laravel environment detection mechanism) then all outgoing mails will be sent to this special address regardless of what address is passed to Mailer as recipient.
return.path: Return path of sent mails. All bounce reports will be delivered to an alias of this address.

Basic Usage

Before using Citco Mailer you should edit src/config/config.php wich includes some configuration variables. After editing this file, when using Citco Mailer for outgoing email messages, it will add information needed for tracking to the message.

License

Citco Mailer is open source software licensed under the MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

citco / mailer

Maintainers