PHPackages                             rodchyn/sendgrid-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. rodchyn/sendgrid-php-sdk

ActiveLibrary[Mail & Notifications](/categories/mail)

rodchyn/sendgrid-php-sdk
========================

Sendgrid PHP SDK

1171[1 PRs](https://github.com/rodchyn/sendgrid-php/pulls)PHP

Since Jun 19Pushed 1y ago1 watchersCompare

[ Source](https://github.com/rodchyn/sendgrid-php)[ Packagist](https://packagist.org/packages/rodchyn/sendgrid-php-sdk)[ RSS](/packages/rodchyn-sendgrid-php-sdk/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

sendgrid-php
============

[](#sendgrid-php)

This library allows you to quickly and easily send emails through SendGrid using PHP.

License
-------

[](#license)

Licensed under the MIT License.

Install
-------

[](#install)

```
git clone git@github.com:sendgrid/sendgrid-php.git

```

SendGrid APIs
-------------

[](#sendgrid-apis)

SendGrid provides two methods of sending email: the Web API, and SMTP API. SendGrid recommends using the SMTP API for sending emails. For an explanation of the benefits of each, refer to .

This library implements a common interface to make it very easy to use either API.

Mail Pre-Usage
--------------

[](#mail-pre-usage)

Before we begin using the library, its important to understand a few things about the library architecture...

- The SendGrid Mail object is the means of setting mail data. In general, data can be set in three ways for most elements:

    1. set - reset the data, and initialize it to the given element. This will destroy previous data
    2. set (List) - for array based elements, we provide a way of passing the entire array in at once. This will also destroy previous data.
    3. add - append data to the list of elements.
- Sending an email is as simple as :

    1. Creating a SendGrid Instance
    2. Creating a SendGrid Mail object, and setting its data
    3. Sending the mail using either SMTP API or Web API.

Mail Usage
----------

[](#mail-usage)

To begin using this library, you must first include it

```
include 'path/to/sendgrid-php/SendGrid_loader.php';
```

Then, initialize the SendGrid object with your SendGrid credentials

```
$sendgrid = new SendGrid('username', 'password');
```

Create a new SendGrid Mail object and add your message details

```
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
       setFrom('me@bar.com')->
       setSubject('Subject goes here')->
       setText('Hello World!')->
       setHtml('Hello World!');
```

Send it using the API of your choice (SMTP or Web)

```
$sendgrid->smtp->send($mail);
```

Or

```
$sendgrid->web->send($mail);
```

### Using Categories

[](#using-categories)

Categories are used to group email statistics provided by SendGrid.

To use a category, simply set the category name. Note: there is a maximum of 10 categories per email.

```
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
       ...
       addCategory("Category 1")->
       addCategory("Category 2");
```

### Using Attachments

[](#using-attachments)

Attachments are currently file based only, with future plans for an in memory implementation as well.

File attachments are limited to 7 MB per file.

```
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
       ...
       addAttachment("../path/to/file.txt");
```

### Using Substitutions

[](#using-substitutions)

Substitutions can be used to customize multi-recipient emails, and tailor them for the user

```
$mail = new SendGrid\Mail();
$mail->addTo('john@somewhere.com')->
       addTo("harry@somewhere.com")->
       addTo("Bob@somewhere.com")->
       ...
       setHtml("Hey %name%, we've seen that you've been gone for a while")->
       addSubstitution("%name%", array("John", "Harry", "Bob"));
```

### Using Sections

[](#using-sections)

Sections can be used to further customize messages for the end users. A section is only useful in conjunction with a substition value.

```
$mail = new SendGrid\Mail();
$mail->addTo('john@somewhere.com')->
       addTo("harry@somewhere.com")->
       addTo("Bob@somewhere.com")->
       ...
       setHtml("Hey %name%, you work at %place%")->
       addSubstitution("%name%", array("John", "Harry", "Bob"))->
       addSubstitution("%place%", array("%office%", "%office%", "%home%"))->
       addSection("%office%", "an office")->
       addSection("%home%", "your house");
```

### Using Unique Arguments

[](#using-unique-arguments)

Unique Arguments are used for tracking purposes

```
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
       ...
       addUniqueArgument("Customer", "Someone")->
       addUniqueArgument("location", "Somewhere");
```

### Using Filter Settings

[](#using-filter-settings)

Filter Settings are used to enable and disable apps, and to pass parameters to those apps.

```
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
       ...
       addFilterSetting("gravatar", "enable", 1)->
       addFilterSetting("footer", "enable", 1)->
       addFilterSetting("footer", "text/plain", "Here is a plain text footer")->
       addFilterSetting("footer", "text/html", "Here is an HTML footer");
```

### Using Headers

[](#using-headers)

Headers can be used to add existing sendgrid functionality (such as for categories or filters), or custom headers can be added as necessary.

```
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
       ...
       addHeader("category", "My New Category");
```

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance26

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 64.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/209245?v=4)[Yura Rodchyn](/maintainers/rodchyn)[@rodchyn](https://github.com/rodchyn)

---

Top Contributors

[![rodchyn](https://avatars.githubusercontent.com/u/209245?v=4)](https://github.com/rodchyn "rodchyn (9 commits)")[![cjbuchmann](https://avatars.githubusercontent.com/u/526429?v=4)](https://github.com/cjbuchmann "cjbuchmann (5 commits)")

### Embed Badge

![Health badge](/badges/rodchyn-sendgrid-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/rodchyn-sendgrid-php-sdk/health.svg)](https://phpackages.com/packages/rodchyn-sendgrid-php-sdk)
```

###  Alternatives

[mattketmo/email-checker

Throwaway email detection library

2752.1M5](/packages/mattketmo-email-checker)[sarfraznawaz2005/noty

Laravel package to incorporate noty flash notifications into laravel.

324.5k](/packages/sarfraznawaz2005-noty)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)