Download the PHP package sprintcube/cakephp-sendgrid without Composer
On this page you can find all versions of the php package sprintcube/cakephp-sendgrid. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sprintcube/cakephp-sendgrid
More information about sprintcube/cakephp-sendgrid
Files in sprintcube/cakephp-sendgrid
Package cakephp-sendgrid
Short Description SendGrid plugin for CakePHP 4 - Send emails using SendGrid API
License MIT
Informations about the package cakephp-sendgrid
SendGrid Plugin for CakePHP
This plugin provides email delivery using SendGrid.
This branch is for use with CakePHP 4.0+. For CakePHP 3, please use cake-3.x branch.
Requirements
This plugin has the following requirements:
- CakePHP 4.0 or greater.
- PHP 7.2 or greater.
Installation
You can install this plugin into your CakePHP application using composer.
After installation, Load the plugin
Or, you can load the plugin using the shell command
Setup
Set your SendGrid Api key in EmailTransport
settings in app.php
And create new delivery profile in Email
settings.
Usage
You can now simply use the CakePHP Email
to send an email via SendGrid.
That is it.
Advance Use
You can also use few more options to send email via SendGrid APIs. To do so, just call the appropriate methods before sending the email.
Custom Headers
You can pass your own headers. It must be prefixed with "X-". Use the default Email::setHeaders
method like,
When sending request,
X-
will be removed from header name e.g. X-MyHeader will become MyHeader
Attachments
Set your attachments using Email::setAttachments
method.
To send inline attachment, use
contentId
parameter while setting attachment.
Template
You can use the template created in SendGrid backend. Get the template id by either using their API or from the URL.
Set the template id using setTemplate
method.
Schedule
You can schedule the email to be sent in future date. You can set upto 72 hours in future as per SendGrid documentation. You need to pass a unix timestamp value.
Reporting Issues
If you have a problem with this plugin or any bug, please open an issue on GitHub.