https://github.com/expertcoder/swiftmailersendgridbundle
Symfony bundle for SendGrid. Utilizes the SendGrid PHP Library https://github.com/sendgrid/sendgrid-php to make it compatible with SwiftMailer
https://github.com/expertcoder/swiftmailersendgridbundle
php sendgrid swiftmailer symfony-bundle symfony2 symfony3 symfony4
Last synced: 9 months ago
JSON representation
Symfony bundle for SendGrid. Utilizes the SendGrid PHP Library https://github.com/sendgrid/sendgrid-php to make it compatible with SwiftMailer
- Host: GitHub
- URL: https://github.com/expertcoder/swiftmailersendgridbundle
- Owner: expertcoder
- License: mit
- Created: 2016-11-24T14:24:02.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-28T14:12:53.000Z (about 6 years ago)
- Last Synced: 2025-03-22T19:51:27.025Z (9 months ago)
- Topics: php, sendgrid, swiftmailer, symfony-bundle, symfony2, symfony3, symfony4
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 14
- Watchers: 2
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftmailerSendGridBundle
[](https://github.com/expertcoder/SwiftmailerSendGridBundle/releases)
[](LICENSE)
[](https://travis-ci.org/expertcoder/SwiftmailerSendGridBundle)
Symfony bundle for SendGrid. Utilizes the SendGrid PHP Library https://github.com/sendgrid/sendgrid-php
to make it compatiable with SwiftMailer.
**Older version (1.x) can be found here:** https://github.com/expertcoder/SwiftmailerSendGridBundle/tree/1.x
## Installation
`composer require expertcoder/swiftmailer-send-grid-bundle`
**or manually**
*composer.json*
```json
"require": {
...
"expertcoder/swiftmailer-send-grid-bundle": "~2.0"
}
```
*config/packages/swiftmailer.yaml*
```yml
swiftmailer:
transport: expertcoder_swift_mailer.send_grid
```
Don't forget to set your Sendgrid API Key in your *.env* file, and that you can set your mail's categories from `config/packages/expert_coder_swiftmailer_send_grid.yaml`
Applications that don't use Symfony Flex
----------------------------------------
*AppKernel.php*
```php
$bundles = [
// ...
new ExpertCoder\Swiftmailer\SendGridBundle\ExpertCoderSwiftmailerSendGridBundle(),
];
```
*parameters.yml.dist*
```yml
parameters:
sendgrid_api_key: PleaseEnterSendGridApiKey
```
*config.yml*
```yml
swiftmailer:
transport: expertcoder_swift_mailer.send_grid
expert_coder_swiftmailer_send_grid:
api_key: %sendgrid_api_key%
categories: [my_category] # optional, will be added to all mails sent (can be seen on sendgrid dashboard)
```
Symfony 3
---------
Since Symfony 3.2, you must name the custom transport service swiftmailer.mailer.transport.< name > so you can use one of the solutions below:
*services.yml*
```yml
services:
swiftmailer.mailer.transport.expertcoder_swift_mailer.send_grid.transport:
alias: expertcoder_swift_mailer.send_grid.transport
```
**OR**
*config.yml*
```yml
swiftmailer:
transport: 'swiftmailer.mailer.transport.expertcoder_swift_mailer.send_grid'
```
## Tests
This bundle provide a little helper to launch tests locally and here is a quick explanation:
* The `config_test.yml` file contains configuration associated with the bundle.
* The `manual-test.sh` helps you test against a specific symfony version and is the main helper to execute tests. You just have to do `sh tests/manual-test.sh versionNumber` where versionNumber is the main Symfony version you want to test (ex: 4)
* The last file contains PhpUnit tests with help of `nyholm/symfony-bundle-test`. Note that we set a timeout of 1sec when sending mail to sendgrid as we do not test the actual sendgrid API with a real key.
## Important !
Following RFC 1341, section 7.2, if either `text/html` or `text/plain` are to be sent in your email: `text/plain` needs to be first, followed by `text/html`, followed by any other content.
For more informations, please see [SwiftMailer](https://swiftmailer.symfony.com/docs/messages.html#quick-reference) and [RFC 1341](https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html)