SendGrid's smtpapi library in PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

SendGrid Logo

BuildStatus Latest Stable Version Latest Version on Packagist Email Notifications Badge Twitter Follow GitHub contributors MIT licensed

This module helps build SendGrid's SMTP API headers.

Learn more about the SMTP API at SendGrid's documentation.

Announcements

All updates to this module is documented in our CHANGELOG.

Table of Contents

Installation

Prerequisites

  • PHP version 5.6 or 7.0
  • The SendGrid service, starting at the free level

Install with Composer

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

Add the following to your composer.json file.

{
    "require": {
        "sendgrid/smtpapi": "~0.6@dev"
    }
}

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.

Setup Environment Variables

Environment Variable

Update the development environment with your SENDGRID_API_KEY, for example:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env

Quick Start

$header = new Smtpapi\Header();
$header->addTo('test1@example.com');
$header->addTo('test2@example.com');
print $header->jsonString();

Usage

Roadmap

If you are interested in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

How to Contribute

We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

Quick links:

About

smtpapi-php is guided and supported by the SendGrid Developer Experience Team.

smtpapi-php is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-php are trademarks of SendGrid, Inc.

License

The MIT License (MIT)