Search by 
priyolahiri / sendgrid-php
This library allows you to quickly and easily send emails through SendGrid using PHP.
1.0.0
2013-04-03 10:25 UTC
This package is not auto-updated.
Last update: 2024-04-22 09:29:13 UTC
README
This library allows you to quickly and easily send emails through SendGrid using PHP.
License
Licensed under the MIT License.
Downloading
Installing the SendGrid package is as simple as adding it to your project's include path and requiring it. If you're using git, you can just clone down the repo like this:
git clone git@github.com:sendgrid/sendgrid-php.git
Note: If you don't have git or would rather install by unpacking a Zip or Tarball, you can always grab the latest version of the package from the downloads page.
Testing
The existing tests in the Test directory can be run using PHPUnit with the following command:
phpunit Test/
```
## 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 http://docs.sendgrid.com/documentation/get-started/integrate/examples/smtp-vs-rest/.
This library implements a common interface to make it very easy to use either API.
## 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
1. Creating a SendGrid Mail object, and setting its data
1. Sending the mail using either SMTP API or Web API.
## Mail Usage ##
To begin using this library, you must first include it
```php
include 'path/to/sendgrid-php/SendGrid_loader.php';
```
Then, initialize the SendGrid object with your SendGrid credentials
```php
$sendgrid = new SendGrid('username', 'password');
```
Create a new SendGrid Mail object and add your message details
```php
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
setFrom('me@bar.com')->
setSubject('Subject goes here')->
setText('Hello World!')->
setHtml('<strong>Hello World!</strong>');
```
Send it using the API of your choice (SMTP or Web)
```php
$sendgrid->smtp->send($mail);
```
Or
```php
$sendgrid->web->send($mail);
```
### 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.
```php
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
...
addCategory("Category 1")->
addCategory("Category 2");
```
### 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.
```php
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
...
addAttachment("../path/to/file.txt");
```
### Using Substitutions ###
Substitutions can be used to customize multi-recipient emails, and tailor them for the user
```php
$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 ###
Sections can be used to further customize messages for the end users. A section is only useful in conjunction with a substition value.
```php
$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 ###
Unique Arguments are used for tracking purposes
```php
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
...
addUniqueArgument("Customer", "Someone")->
addUniqueArgument("location", "Somewhere");
```
### Using Filter Settings ###
Filter Settings are used to enable and disable apps, and to pass parameters to those apps.
```php
$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", "<p style='color:red;'>Here is an HTML footer</p>");
```
### 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.
```php
$mail = new SendGrid\Mail();
$mail->addTo('foo@bar.com')->
...
addHeader("category", "My New Category");
```