sendgrid/smtpapi

Build SendGrid X-SMTPAPI headers in PHP.

0.6.7 2020-10-14 18:37 UTC

This package is auto-updated.

Last update: 2021-09-12 21:39:18 UTC


README

Twilio SendGrid Logo

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

This module helps build Twilio SendGrid's SMTP API headers.

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

Announcements

The default branch name for this repository has been changed to main as of 07/27/2020.

All the updates to this module are documented in our CHANGELOG.

Table of Contents

Installation

Prerequisites

  • PHP version 5.6, 7.0, 7.1, 7.2, 7.3, or 7.4
  • The Twilio SendGrid service, starting at the free level

Install with Composer

The following recommended installation requires composer.

Add the following to your composer.json file.

{
    "require": {
        "sendgrid/smtpapi": "^0.6.7"
    }
}

Then at the top of your script require the autoloader:

require 'vendor/autoload.php';

Alternative: Install package from zip

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

⬇︎ Download Packaged Library ⬇︎

Then require the library from package:

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

The previous versions of the library can be downloaded directly from GitHub.

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

How to Contribute

We encourage contributions to our projects; please see our CONTRIBUTING guide for details.

Quick links:

About

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

If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

License

The MIT License (MIT)