qwant50/mailer

Jazz framework mailer component

Maintainers

Details

github.com/qwant50/mailer

Source

Issues

Installs: 24

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

3.0.0 2016-02-10 18:44 UTC

Requires

Requires (Dev)

MIT fdcc3ecffe1cedb9fce202f0e7ed5ca05d0bb42b

  • Sergey Malahov <qwantonline.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-11-09 19:04:39 UTC

README

Jazz framework mailer component

Installation

The preferred way to install this ITCourses framework mailer component is through composer.

Either run

php composer.phar require "qwant50/mailer"

or add

"qwant50/mailer": "~3.0.*"

to the require section of your composer.json.

Usage

####1. You MUST to init $config array from the config file path/to/config/mailer.php

return [
    'transport' => 'SmtpTransport',
    'host' => 'smtp.domain.com',
    'port' => 587,
    'smtp_username' => 'username',
    'smtp_password' => 'password',
    'mailFrom' => 'transportMailAddress@domain.com',
    'debug' => 5,  //  0 - disable debug messages
];

####2. Set some message headers. "RECOMMENDED"

use Qwant\Mailer;
use Qwant\Message;

$message = new Message();

$message->addHeader('Error-to', 'example@domain.com')
        ->addHeader('From', 'example@domain.com')
        ->addHeader('To', 'example@domain.com')
        ->addHeader('Subject', 'Text field.');

####3. Set body and mailTo fields MUST

$message->setBody('Message's body.');
$message->setMailTo('example@domain.com');

####4. Send a message

$mailer = new Mailer($config);

if ($mailer->send($message)) {
    // Success
} else {
    // Error
};

Copyright © 2015-2016, ITCourses