diff options
Diffstat (limited to 'Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/README.md')
| -rw-r--r-- | Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/README.md | 233 |
1 files changed, 114 insertions, 119 deletions
diff --git a/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/README.md b/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/README.md index 2add305..79d38ee 100644 --- a/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/README.md +++ b/Postman/Postman-Mail/sendgrid/vendor/sendgrid/sendgrid/README.md @@ -1,208 +1,201 @@ + + [](https://travis-ci.org/sendgrid/sendgrid-php) +[](https://packagist.org/packages/sendgrid/sendgrid) +[](https://packagist.org/packages/sendgrid/sendgrid) +[](https://dx.sendgrid.com/newsletter/php) +[](./LICENSE.md) +[](https://twitter.com/sendgrid) +[](https://github.com/sendgrid/sendgrid-php/graphs/contributors) +[](https://www.codetriage.com/sendgrid/sendgrid-php) -Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-php/issues/290). Your support is appreciated! +**NEW:** +- Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/php) for releases and breaking changes. +- Send SMS messages with [Twilio](https://github.com/sendgrid/sendgrid-php/blob/master/USE_CASES.md#sms). -**This library allows you to quickly and easily use the SendGrid Web API v3 via PHP.** +**This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via PHP.** -Version 5.X.X of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint). +Version 7.X.X of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint). -This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-php/issues) and [pull requests](https://github.com/sendgrid/sendgrid-php/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests. +We want this library to be community driven and Twilio SendGrid led. Your help is needed to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-php/issues) and [pull requests](https://github.com/sendgrid/sendgrid-php/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests. -Please browse the rest of this README for further detail. +Please browse the rest of this README for further details. We appreciate your continued support, thank you! # Table of Contents * [Installation](#installation) -* [Quick Start](#quick_start) +* [Quick Start](#quick-start) +* [Use Cases](#use-cases) * [Usage](#usage) -* [Use Cases](#use_cases) * [Announcements](#announcements) * [Roadmap](#roadmap) * [How to Contribute](#contribute) * [Troubleshooting](#troubleshooting) * [About](#about) +* [License](#license) <a name="installation"></a> # Installation ## Prerequisites -- PHP version 5.6 or 7.0 -- The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-php) +- PHP version 5.6, 7.0, 7.1 or 7.2 +- The Twilio SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-php) to send up to 40,000 emails for the first 30 days, then send 100 emails/day free forever or check out [our pricing](https://sendgrid.com/pricing?source=sendgrid-php). +- For SMS messages, you will need a free [Twilio account](https://www.twilio.com/try-twilio?source=sendgrid-php). ## Setup Environment Variables Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example: +1. Copy the sample env file to a new file named `.env` +```bash +cp .env.sample .env +``` +2. Edit the `.env` file to include your `SENDGRID_API_KEY` +3. Source the `.env` file ```bash -echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env -echo "sendgrid.env" >> .gitignore -source ./sendgrid.env +source ./.env ``` ## Install Package -Add SendGrid to your `composer.json` file. If you are not using [Composer](http://getcomposer.org), you should be. It's an excellent way to manage dependencies in your PHP application. +Add Twilio SendGrid to your `composer.json` file. If you are not using [Composer](http://getcomposer.org), we highly recommend it. It's an excellent way to manage dependencies in your PHP application. ```json { "require": { - "sendgrid/sendgrid": "~6.0" + "sendgrid/sendgrid": "~7" } } ``` #### 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](https://github.com/sendgrid/sendgrid-php/archive/master.zip)**. +If you are not using Composer, simply download and install the **[latest packaged release of the library as a zip](https://github.com/sendgrid/sendgrid-php/releases/download/v7.3.0/sendgrid-php.zip)**. -[**⬇︎ Download Packaged Library ⬇︎**](https://github.com/sendgrid/sendgrid-php/archive/master.zip) +[**⬇︎ Download Packaged Library ⬇︎**](https://github.com/sendgrid/sendgrid-php/releases/download/v7.3.0/sendgrid-php.zip) -Previous versions of the library can be found in the [version index](https://sendgrid-open-source.s3.amazonaws.com/index.html) or downloaded directly from GitHub. +Previous versions of the library can be found in the [version index](https://sendgrid-open-source.s3.amazonaws.com/index.html) or downloaded directly from [GitHub](https://github.com/sendgrid/sendgrid-php/releases). ## Dependencies -- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-php) -- [php-HTTP-Client](https://github.com/sendgrid/php-http-client) +- The Twilio SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-php) +- The dependency free [php-http-client](https://github.com/sendgrid/php-http-client) -<a name="quick_start"></a> +<a name="quick-start"></a> # Quick Start ## Hello Email -The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-php/tree/master/lib/helpers/mail) ([here](https://github.com/sendgrid/sendgrid-php/blob/master/examples/helpers/mail/example.php#L22) is a full example): +The following is the minimum needed code to send an email. You may find more examples in our USE_CASES file: ```php <?php -// If you are using Composer (recommended) -require 'vendor/autoload.php'; - -// If you are not using Composer -// require("path/to/sendgrid-php/sendgrid-php.php"); - -$from = new SendGrid\Email("Example User", "test@example.com"); -$subject = "Sending with SendGrid is Fun"; -$to = new SendGrid\Email("Example User", "test@example.com"); -$content = new SendGrid\Content("text/plain", "and easy to do anywhere, even with PHP"); -$mail = new SendGrid\Mail($from, $subject, $to, $content); - -$apiKey = getenv('SENDGRID_API_KEY'); -$sg = new \SendGrid($apiKey); - -$response = $sg->client->mail()->send()->post($mail); -echo $response->statusCode(); -print_r($response->headers()); -echo $response->body(); +require 'vendor/autoload.php'; // If you're using Composer (recommended) +// Comment out the above line if not using Composer +// require("<PATH TO>/sendgrid-php.php"); +// If not using Composer, uncomment the above line and +// download sendgrid-php.zip from the latest release here, +// replacing <PATH TO> with the path to the sendgrid-php.php file, +// which is included in the download: +// https://github.com/sendgrid/sendgrid-php/releases + +$email = new \SendGrid\Mail\Mail(); +$email->setFrom("test@example.com", "Example User"); +$email->setSubject("Sending with Twilio SendGrid is Fun"); +$email->addTo("test@example.com", "Example User"); +$email->addContent("text/plain", "and easy to do anywhere, even with PHP"); +$email->addContent( + "text/html", "<strong>and easy to do anywhere, even with PHP</strong>" +); +$sendgrid = new \SendGrid(getenv('SENDGRID_API_KEY')); +try { + $response = $sendgrid->send($email); + print $response->statusCode() . "\n"; + print_r($response->headers()); + print $response->body() . "\n"; +} catch (Exception $e) { + echo 'Caught exception: '. $e->getMessage() ."\n"; +} ``` -The `SendGrid\Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](https://github.com/sendgrid/sendgrid-php/blob/master/examples/helpers/mail/example.php#L16) is an example of how to add to it. - -### Without Mail Helper Class - -The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-php/blob/master/examples/mail/mail.php#L28) is a full example): - -```php -<?php -// If you are using Composer (recommended) -require 'vendor/autoload.php'; - -// If you are not using Composer -// require("path/to/sendgrid-php/sendgrid-php.php"); - -$request_body = json_decode('{ - "personalizations": [ - { - "to": [ - { - "email": "test@example.com" - } - ], - "subject": "Sending with SendGrid is Fun" - } - ], - "from": { - "email": "test@example.com" - }, - "content": [ - { - "type": "text/plain", - "value": "and easy to do anywhere, even with PHP" - } - ] -}'); - -$apiKey = getenv('SENDGRID_API_KEY'); -$sg = new \SendGrid($apiKey); - -$response = $sg->client->mail()->send()->post($request_body); -echo $response->statusCode(); -echo $response->body(); -print_r($response->headers()); -``` +The `SendGrid\Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](https://github.com/sendgrid/sendgrid-php/blob/master/USE_CASES.md#kitchen-sink) is an example of how to add to it. ## General v3 Web API Usage (With Fluent Interface) ```php <?php -// If you are using Composer (recommended) -require 'vendor/autoload.php'; - -// If you are not using Composer -// require("path/to/sendgrid-php/sendgrid-php.php"); +require 'vendor/autoload.php'; // If you're using Composer (recommended) +// Comment out the above line if not using Composer +// Comment out the above line if not using Composer +// require("<PATH TO>/sendgrid-php.php"); +// If not using Composer, uncomment the above line and +// download sendgrid-php.zip from the latest release here, +// replacing <PATH TO> with the path to the sendgrid-php.php file, +// which is included in the download: +// https://github.com/sendgrid/sendgrid-php/releases $apiKey = getenv('SENDGRID_API_KEY'); $sg = new \SendGrid($apiKey); -$response = $sg->client->suppression()->bounces()->get(); - -print $response->statusCode(); -print $response->headers(); -print $response->body(); +try { + $response = $sg->client->suppression()->bounces()->get(); + print $response->statusCode() . "\n"; + print_r($response->headers()); + print $response->body() . "\n"; +} catch (Exception $e) { + echo 'Caught exception: '. $e->getMessage(). "\n"; +} ``` ## General v3 Web API Usage (Without Fluent Interface) ```php <?php -// If you are using Composer (recommended) -require 'vendor/autoload.php'; - -// If you are not using Composer -// require("path/to/sendgrid-php/sendgrid-php.php"); +require 'vendor/autoload.php'; // If you're using Composer (recommended) +// Comment out the above line if not using Composer +// Comment out the above line if not using Composer +// require("<PATH TO>/sendgrid-php.php"); +// If not using Composer, uncomment the above line and +// download sendgrid-php.zip from the latest release here, +// replacing <PATH TO> with the path to the sendgrid-php.php file, +// which is included in the download: +// https://github.com/sendgrid/sendgrid-php/releases $apiKey = getenv('SENDGRID_API_KEY'); $sg = new \SendGrid($apiKey); -$response = $sg->client->_("suppression/bounces")->get(); - -print $response->statusCode(); -print $response->headers(); -print $response->body(); +try { + $response = $sg->client->_("suppression/bounces")->get(); + print $response->statusCode() . "\n"; + print_r($response->headers()); + print $response->body() . "\n"; +} catch (Exception $e) { + echo 'Caught exception: '. $e->getMessage(). "\n"; +} ``` +<a name="use-cases"></a> +# Use Cases + +[Examples of common API use cases](https://github.com/sendgrid/sendgrid-php/blob/master/USE_CASES.md), such as how to send an email with a transactional template. + <a name="usage"></a> # Usage -- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html) -- [Library Usage +- [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html) +- [Generic Library Usage Documentation](https://github.com/sendgrid/sendgrid-php/tree/master/USAGE.md) -- [Example Code](https://github.com/sendgrid/sendgrid-php/tree/master/examples) -- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html) -- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-php/tree/master/lib/helpers/mail/README.md) - build a request object payload for a v3 /mail/send API call. - -<a name="use_cases"> -# Use Cases - -[Examples of common API use cases](https://github.com/sendgrid/sendgrid-php/blob/master/USE_CASES.md), such as how to send an email with a transactional template. +- [Example Code](https://github.com/sendgrid/sendgrid-php/blob/master/USE_CASES.md) <a name="announcements"></a> # Announcements -Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-php/issues/290). Your support is appreciated! +v7 has been released! Please see the [release notes](https://github.com/sendgrid/sendgrid-php/releases/tag/v7.0.0) for details. -All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-php/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-php/releases) +All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-php/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-php/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/php) for releases and breaking changes. <a name="roadmap"></a> # Roadmap @@ -220,6 +213,7 @@ Quick links: - [Bug Reports](https://github.com/sendgrid/sendgrid-php/blob/master/CONTRIBUTING.md#submit_a_bug_report) - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-php/blob/master/CONTRIBUTING.md#cla) - [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-php/blob/master/CONTRIBUTING.md#improvements_to_the_codebase) +- [Review Pull Requests](https://github.com/sendgrid/sendgrid-php/blob/master/CONTRIBUTING.md#code-reviews) <a name="troubleshooting"></a> # Troubleshooting @@ -229,9 +223,10 @@ Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-php/ <a name="about"></a> # About -sendgrid-php is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com). +sendgrid-php is guided and supported by the Twilio [Developer Experience Team](mailto:dx@sendgrid.com). -sendgrid-php is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-php are trademarks of SendGrid, Inc. +sendgrid-php is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-php are trademarks of Twilio SendGrid, Inc. - +# License +[The MIT License (MIT)](LICENSE.txt) |