Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xedi/library-php-sendgrid
First Party SendGrid PHP Library
https://github.com/xedi/library-php-sendgrid
sendgrid sendgrid-api-wrapper
Last synced: 2 days ago
JSON representation
First Party SendGrid PHP Library
- Host: GitHub
- URL: https://github.com/xedi/library-php-sendgrid
- Owner: xedi
- License: mit
- Created: 2019-09-16T14:23:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-24T13:30:45.000Z (almost 3 years ago)
- Last Synced: 2024-12-06T13:16:41.996Z (21 days ago)
- Topics: sendgrid, sendgrid-api-wrapper
- Language: PHP
- Size: 152 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/xedi/library-php-sendgrid/actions)
[](https://github.com/xedi/library-php-sendgrid/actions)
[](https://app.dependabot.com/accounts/xedi/repos/208819381)
[](https://packagist.org/packages/xedi/sendgrid)
# Table of Contents
* [Installation](#installation)
* [Quick Start](#quick-start)
* [About](#about)
* [Feature Requests](#feature-requests)
* [Security Vulnerabilities](#security-vulnerabilities)
### Prerequisites
* PHP 7.1+
* A SendGrid account and [API Key][SENDGRID_API_KEY]
### Install Package
Add [XEDI][XEDI] SendGrid to your `composer.json` file either manually or using `composer require`.
```json
{
"require": {
"xedi/sendgrid": "^1"
}
}
```
```shell
composer require xedi/sendgrid
```
**We recommend the later option, let composer do it's thing**
```php
setSender('[email protected]', 'Joe Blogs')
->setSubject('Checkout XEDI\'s SendGrid library!')
->addTextContent('Hey,\n\rI found this great SendGrid library!')
->addHtmlContent('Hey,
I found this great SendGrid library!')
->addRecipient('[email protected]', 'John Smith');
try {
SendGrid::send($mailable);
} catch (SendGridException $exception) {
echo 'Caught exception: ' . (string) $exception;
}
```
This library uses [SendGrids v3 HTTP API][SENDGRID_API_DOCS]. It builts on some of the limitations of the "official" library such as:
* Interacts with cURL directly limiting your ability to intercept requests during tests.
* Exceptions aren't specific to the returned error.
We employ [GuzzleHttp][GUZZLEHTTP] to act as our cURL wrapper off-loading responsibility of processing HTTP requests. Guzzle 6 provides a great utility for intercepting HTTP requests made through it's client; for more details [click here][GUZZLEHTTP_TESTING].
SendGrid only returns one error code if there is a problem with your payload! This is because SendGrid's API is not RESTful. Our library will attempt to provide contextual exceptions such as `Xedi\SendGrid\Exceptions\Domain\SubjectException`, which would be thrown if SendGrid reports an issue with your subject field.
All exceptions can be identified using our `ExceptionContract` which all exceptions implement.
This library was developed for an in-house project, and it's features will grow as our requirements change. **However**, if there is something we don't support please raise a GitHub issue.
We take security very seriously. If you spot something, please let us know by emailing use at [[email protected]][SECURITY_REPORTING_LINK].
[XEDI]: https://xedi.com
[GUZZLEHTTP]: http://docs.guzzlephp.org
[GUZZLEHTTP_TESTING]: http://docs.guzzlephp.org/en/stable/testing.html
[SENDGRID_API_DOCS]: https://sendgrid.com/docs/api-reference/
[SENDGRID_API_KEY]: https://app.sendgrid.com/settings/api_keys
[SECURITY_REPORTING_LINK]: mailto:[email protected]?subject=Security%20Vulnerability%20Found%20-%20Xedi%2FSendGrid