rawphp/raw-mail

RawMail is a wrapper around PHPMailer and is used by RawPHP framework and other applications.

dev-master / 0.x-dev 2014-12-16 09:42 UTC

Requires

• php: >=5.3.0
• phpmailer/phpmailer: v5.2.8
• rawphp/raw-dispatcher: dev-master
• rawphp/raw-support: dev-master

Requires (Dev)

• phpunit/phpunit: 4.2.5
• rawphp/raw-code-standards: 1.*@dev
• satooshi/php-coveralls: dev-master

MIT

• Tom Kaczocha

• email
• smtp

README

Package Features

• Simple to use mailer
• SMTP support
• Supports attachments

Installation

Composer

RawMail is available via Composer/Packagist.

Add "rawphp/raw-mail": "0.*@dev" to the require block in your composer.json and then run composer install.

{
        "require": {
            "rawphp/raw-mail": "0.*@dev"
        }
}

You can also simply run the following from the command line:

composer require rawphp/raw-mail "0.*@dev"

Tarball

Alternatively, just copy the contents of the RawMail folder into somewhere that's in your PHP include_path setting. If you don't speak git or just want a tarball, click the 'zip' button at the top of the page in GitHub.

Basic Usage

<?php

use RawPHP\RawMail\Mail;

// configuration
$config = array(
    'from_email'   => '[e-mail]',                // default from email to use in emails
    'from_name'    => 'RawPHP',                             // default from name to use in emails
    
    'smtp' => array( 'auth'     => TRUE ),                  // enable SMTP authentication
    'smtp' => array( 'host'     => 'smtp.gmail.com' ),      // main and backup SMTP servers
    'smtp' => array( 'username' => 'username' ),            // SMTP username
    'smtp' => array( 'password' => 'password' ),            // SMTP password
    'smtp' => array( 'security' => 'ssl' ),                 // Enable TLS encryption, 'ssl' also accepted
    'smtp' => array( 'port'     => '465' ),                 // SMTP port
);

// instantiate new mail instance
$mail = new Mail( );

// initialise mailer
$mail->init( $config );

// add recipient
$mail->addTo( array( '[e-mail]', 'John Smith' ) );

// set subject
$mail->setSubject( 'Demo Message' );

// set body
$mail->setBody( '<h2>Hello from Demo</h2>' );

// add attachment
$mail->addAttachment( '/path/to/file' );

$mail->send( );

License

This package is licensed under the MIT. Read LICENSE for information on the software availability and distribution.

Contributing

Please submit bug reports, suggestions and pull requests to the GitHub issue tracker.

Changelog

22-09-2014

• Updated to PHP 5.3.

20-09-2014

• Replaced php array configuration with yaml

18-09-2014

• Updated to work with the latest rawphp/rawbase package.

13-09-2014

• Initial Code Commit.