sendgrid/smtpapi

Build SendGrid X-SMTPAPI headers in PHP.

Installs: 5 871 191

Dependents: 3

Suggesters: 0

Security: 0

Stars: 68

Watchers: 204

Forks: 63

0.7.0 2022-05-04 20:42 UTC

This package is auto-updated.

Last update: 2024-03-01 00:11:34 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

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

Table of Contents

Installation

Prerequisites

  • PHP version 7.3, 7.4, 8.0, or 8.1
  • 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.7.0"
    }
}

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.

Support

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

License

The MIT License (MIT)