sprintcube/cakephp-sendgrid

SendGrid plugin for CakePHP 4 - Send emails using SendGrid API

Installs: 2 452

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 3

Forks: 4

Open Issues: 3

Type:cakephp-plugin

4.0.1 2022-04-20 05:40 UTC

This package is auto-updated.

Last update: 2022-07-30 12:31:35 UTC


README

CI codecov Software License Latest Stable Version Total Downloads

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.

composer require sprintcube/cakephp-sendgrid

After installation, Load the plugin

Plugin::load('SendGrid');

Or, you can load the plugin using the shell command

$ bin/cake plugin load SendGrid

Setup

Set your SendGrid Api key in EmailTransport settings in app.php

'EmailTransport' => [
...
  'sendgrid' => [
      'className' => 'SendGrid.SendGrid',
      'apiKey' => 'your-api-key' // your api key
  ]
]

And create new delivery profile in Email settings.

'Email' => [
    'default' => [
        'transport' => 'default',
        'from' => 'you@localhost',
        //'charset' => 'utf-8',
        //'headerCharset' => 'utf-8',
    ],
    'sendgrid' => [
        'transport' => 'sendgrid'
    ]
]

Usage

You can now simply use the CakePHP Email to send an email via SendGrid.

$email = new SendGridMailer();
$email->setFrom(['you@yourdomain.com' => 'CakePHP SendGrid'])
    ->setTo('foo@example.com.com')
    ->addTo('bar@example.com')
    ->addCc('john@example.com')
    ->setSubject('Email from CakePHP SendGrid plugin')
    ->deliver('Message from CakePHP SendGrid plugin');

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,

$email = new SendGridMailer();
$email->setFrom(['you@yourdomain.com' => 'CakePHP SendGrid'])
    ->setTo('foo@example.com.com')
    ->setHeaders([
        'X-Custom' => 'headervalue',
        'X-MyHeader' => 'myvalue'
    ])
    ->setSubject('Email from CakePHP SendGrid plugin')
    ->deliver('Message from CakePHP SendGrid plugin');

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.

$email = new SendGridMailer();
$email->setFrom(['you@yourdomain.com' => 'CakePHP SendGrid'])
    ->setTo('foo@example.com.com')
    ->setSubject('Email from CakePHP SendGrid plugin')
    ->setAttachments([
        'cake_icon1.png' => Configure::read('App.imageBaseUrl') . 'cake.icon.png',
        'cake_icon2.png' => ['file' => Configure::read('App.imageBaseUrl') . 'cake.icon.png'],
        WWW_ROOT . 'favicon.ico'
    ])
    ->deliver('Message from CakePHP SendGrid plugin');

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.

$email = new SendGridMailer();
$email->setTo('foo@example.com.com')
    ->setTemplate('d-xxxxxx')
    ->deliver();

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.

$email = new SendGridMailer();
$email->setTo('foo@example.com.com')
    ->setSendAt(1649500630)
    ->deliver();

Reporting Issues

If you have a problem with this plugin or any bug, please open an issue on GitHub.