MAth-Cloud-3.0.0/www.ipsocloud.com/intimamedia.com/www.intimamedia.com/services/sendgrid-php/vendor/sendgrid/smtpapi/README.md

SMTPAPI-PHP

This php library allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.

Installation

The following recommended installation requires http://getcomposer.org.

Add the following to your composer.json file.

{
    "minimum-stability" : "dev",
    "require": {
        "sendgrid/smtpapi": "~0.5"
    }
}

Then at the top of your script require the autoloader:

require 'vendor/autoload.php';

Alternative: Install from zip

If you are not using Composer, simply download and install the latest packaged release of the library as a zip.

Then require the library from package:

require('path/to/smtpapi-php/smtpapi-php.php');

Previous versions of the library can be found in the version index.

Usage

Initializing

$header = new Smtpapi\Header();

jsonString

This gives you back the stringified json formatted X-SMTPAPI header. Use this with your smtp client of choice.

$header = new Smtpapi\Header();
$header->jsonString();

If you don't want to unicode escape, you can set options parameter for jsonString() (PHP 5.4 or later).

$header = new Smtpapi\Header();
$header->jsonString(JSON_UNESCAPED_UNICODE);

addTo

$header = new Smtpapi\Header();
$header->addTo('you@youremail.com');
$header->addTo('other@otheremail.com');

setTos

$header = new Smtpapi\Header();
$header->setTos(array('you@youremail.com', 'other@otheremail.com'));

setSendAt

$header = new Smtpapi\Header();
$header->setSendAt(1409348513);

setSendEachAt

$header = new Smtpapi\Header();
$header->setSendEachAt(array(1409348513, 1409348514, 1409348515));

addSendEachAt

$header = new Smtpapi\Header();
$header->addSendEachAt(1409348513);
$header->addSendEachAt(1409348514);
$header->addSendEachAt(1409348515);

addSubstitution

$header = new Smtpapi\Header();
$header->addSubstitution('keep', array('secret')); // sub = {keep: ['secret']}
$header->addSubstitution('other', array('one', 'two'));   // sub = {keep: ['secret'], other: ['one', 'two']}

setSubstitutions

$header = new Smtpapi\Header();
$header->setSubstitutions(array('keep' => array('secret'))); // sub = {keep: ['secret']}

addUniqueArg

$header = new Smtpapi\Header();
$header->addUniqueArg('cat', 'dogs');

setUniqueArgs

$header = new Smtpapi\Header();
$header->setUniqueArgs(array('cow' => 'chicken'));
$header->setUniqueArgs(array('dad' => 'proud'));

addCategory

$header = new Smtpapi\Header();
$header->addCategory('tactics'); // category = ['tactics']
$header->addCategory('advanced'); // category = ['tactics', 'advanced']

setCategories

$header = new Smtpapi\Header();
$header->setCategories(array('tactics', 'advanced')); // category = ['tactics', 'advanced']

addSection

$header = new Smtpapi\Header();
$header->addSection('-charge-': 'This ship is useless.');
$header->addSection('-bomber-', 'Only for sad vikings.');

setSections

$header = new Smtpapi\Header();
$header->setSections(array('-charge-' => 'This ship is useless.'));

setASMGroupID

$header = new Smtpapi\Header();
$header->setASMGroupID(42);

setIpPool

$header = new Smtpapi\Header();
$header->setIpPool('pool_name');

addFilter

$header = new Smtpapi\Header();
$header->addFilter('footer', 'enable', 1);
$header->addFilter('footer', 'text/html', '<strong>boo</strong>');

setFilters

$header = new Smtpapi\Header();
$filter = array(
  'footer' => array(
    'setting' => array(
      'enable' => 1,
      'text/plain' => 'You can haz footers!'
    )
  )
);
$header->setFilters($filter);

SendGrid SMTP Example

The following example builds the X-SMTPAPI headers and adds them to swiftmailer. Swiftmailer then sends the email through SendGrid. You can use this same code in your application or optionally you can use sendgrid-php.

use Smtpapi\Header;

$transport = \Swift_SmtpTransport::newInstance('smtp.sendgrid.net', 587);
$transport->setUsername('sendgrid_username');
$transport->setPassword('sendgrid_password');

$mailer = \Swift_Mailer::newInstance($transport);

$message = new \Swift_Message();
$message->setTos(array('bar@blurdybloop.com'));
$message->setFrom('foo@blurdybloop.com');
$message->setSubject('Hello');
$message->setBody('%how% are you doing?');

$header = new Header();
$header->addSubstitution('%how%', array('Owl'));

$message_headers = $message->getHeaders();
$message_headers->addTextHeader(HEADER::NAME, $header->jsonString());

try {
    $response = $mailer->send($message);
    print_r($response);
} catch(\Swift_TransportException $e) {
    print_r('Bad username / password');
}

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Running Tests

The existing tests in the test directory can be run using PHPUnit with the following command:

composer install
cd test
../vendor/bin/phpunit

or if you already have PHPUnit installed globally.

cd test
phpunit

Testing uploading to Amazon S3

If you want to test uploading the zipped file to Amazon S3 (SendGrid employees only), do the following.

export S3_SIGNATURE="secret_signature"
export S3_POLICY="secret_policy"
export S3_BUCKET="sendgrid-open-source"
export S3_ACCESS_KEY="secret_access_key"
./scripts/s3upload.sh