sprintcube/cakephp-elastic-email

ElasticEmail plugin for CakePHP 3 - Send transactional emails using Elastic Email API

v1.0.2 2018-08-20 06:06 UTC

This package is auto-updated.

Last update: 2022-07-26 22:42:21 UTC


README

Build Status codecov Software License Latest Stable Version Total Downloads

This plugin provides email delivery using Elastic Email.

Requirements

This plugin has the following requirements:

  • CakePHP 3.4.0 or greater.
  • PHP 5.6 or greater.

Installation

You can install this plugin into your CakePHP application using composer.

composer require sprintcube/cakephp-elastic-email

After installation, Load the plugin

Plugin::load('ElasticEmail');

Or, you can load the plugin using the shell command

$ bin/cake plugin load ElasticEmail

Setup

Set your Elastic Email Api key in EmailTransport settings in app.php

'EmailTransport' => [
...
  'elasticemail' => [
      'className' => 'ElasticEmail.ElasticEmail',
      'apiKey' => 'your-api-key' // your api key
  ]
]

If you face an SSL certificate error, please follow below steps:

  1. Open http://curl.haxx.se/ca/cacert.pem
  2. Copy the entire page and save it as a "cacert.pem"
  3. Open your php.ini file and insert or update the following line: curl.cainfo = "[pathtofile]\cacert.pem"

And create new delivery profile in Email settings.

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

Usage

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

$email = new Email('elasticemail');
        
$email->setFrom(['you@yourdomain.com' => 'CakePHP Elastic Email'])
    ->setSender('someone@example.com', 'Someone')
    ->setTo('foo@example.com.com')
    ->addTo('bar@example.com')
    ->setHeaders(['X-Custom' => 'headervalue'])
    ->setSubject('Email from CakePHP Elastic Email plugin')
    ->send('Message from CakePHP Elastic Email plugin');

That is it.

Advance Use

You can also use few more options to send email via Elastic Email APIs. To do so, get the transport instance and call the appropriate methods before sending the email.

Transactional Email

You can mark the email as transactional email.

$email = new Email('elasticemail');
$emailInstance = $email->getTransport();
$emailInstance->isTransactional(true);
$email->send();

Custom Headers

You can pass your own headers. It must be prefixed with "X-". Use the default Email::setHeaders method like,

$email = new Email('elasticemail');
        
$email->setFrom(['you@yourdomain.com' => 'CakePHP Elastic Email'])
    ->setSender('someone@example.com', 'Someone')
    ->setTo('foo@example.com.com')
    ->addTo('bar@example.com')
    ->setHeaders([
        'X-Custom' => 'headervalue',
        'X-MyHeader' => 'myvalue'
    ])
    ->setSubject('Email from CakePHP Elastic Email plugin')
    ->send('Message from CakePHP Elastic Email plugin');

Make sure you have enabled custom header from your Elastic Email settings.

Attachments

Set your attachments using Email::setAttachments method.

$email = new Email('elasticemail');
        
$email->setFrom(['you@yourdomain.com' => 'CakePHP Elastic Email'])
    ->setSender('someone@example.com', 'Someone')
    ->setTo('foo@example.com.com')
    ->addTo('bar@example.com')
    ->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'
    ])
    ->setSubject('Email from CakePHP Elastic Email plugin')
    ->send('Message from CakePHP Elastic Email plugin');

You need to have some credit in your account to send attachments. Otherwise you will get Not enough credit for campaign. error.

Template

You can use the template created in Elastic Email backend. Get the template id by either using their API or from the URL. Set the template id using setTemplate method.

$email = new Email('elasticemail');
$emailInstance = $email->getTransport();
$emailInstance->setTemplte(123);
$email->send();

Template Variables

Elastic Email provides a nice way to replace the template content using template variables. You can use variables like {firstname}, {lastname} in your template and pass their replacement value.

$mergeVars = [
    'firstname' => 'Foo',
    'lastname' => 'Bar',
    'title' => 'Good Title'
];

$email = new Email('elasticemail');
$emailInstance = $email->getTransport();
$emailInstance->setMergeVariables($mergeVars);

$email->setFrom(['from@example.com' => 'CakePHP Elastic Email'])
    ->setTo('to@example.com')
    ->setEmailFormat('both')
    ->setSubject('{title} - Email from CakePHP Elastic Email plugin')
    ->send('Hello {firstname} {lastname}, <br> This is an email from CakePHP Elastic Email plugin.');

Schedule

You can schedule the email to be sent in future date. You can set upto 1 year in future i.e. 524160 minutes.

$email = new Email('elasticemail');
$emailInstance = $email->getTransport();
$emailInstance->setScheduleTime(60); // after 1 hour from sending time
$email->send();

Reporting Issues

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