https://github.com/sprintcube/cakephp-elastic-email
Elastic Email plugin for CakePHP 3
https://github.com/sprintcube/cakephp-elastic-email
cakephp cakephp-plugin elasticemail email php
Last synced: 3 months ago
JSON representation
Elastic Email plugin for CakePHP 3
- Host: GitHub
- URL: https://github.com/sprintcube/cakephp-elastic-email
- Owner: sprintcube
- License: mit
- Created: 2018-06-22T11:25:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-24T12:14:40.000Z (over 6 years ago)
- Last Synced: 2024-11-29T20:09:42.096Z (6 months ago)
- Topics: cakephp, cakephp-plugin, elasticemail, email, php
- Language: PHP
- Size: 29.3 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elastic Email Plugin for CakePHP 3
[](https://travis-ci.org/sprintcube/cakephp-elastic-email)
[](https://codecov.io/gh/sprintcube/cakephp-elastic-email)
[](LICENSE)
[](https://packagist.org/packages/sprintcube/cakephp-elastic-email)
[](https://packagist.org/packages/sprintcube/cakephp-elastic-email)
This plugin provides email delivery using [Elastic Email](https://elasticemail.com/).
## 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](http://getcomposer.org).
```
composer require sprintcube/cakephp-elastic-email
```
After installation, [Load the plugin](http://book.cakephp.org/3.0/en/plugins.html#loading-a-plugin)
```php
Plugin::load('ElasticEmail');
```
Or, you can load the plugin using the shell command
```sh
$ bin/cake plugin load ElasticEmail
```
## Setup
Set your Elastic Email Api key in `EmailTransport` settings in app.php
```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.
```php
'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.
```php
$email = new Email('elasticemail');
$email->setFrom(['[email protected]' => 'CakePHP Elastic Email'])
->setSender('[email protected]', 'Someone')
->setTo('[email protected]')
->addTo('[email protected]')
->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.
```php
$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,
```php
$email = new Email('elasticemail');
$email->setFrom(['[email protected]' => 'CakePHP Elastic Email'])
->setSender('[email protected]', 'Someone')
->setTo('[email protected]')
->addTo('[email protected]')
->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.
```php
$email = new Email('elasticemail');
$email->setFrom(['[email protected]' => 'CakePHP Elastic Email'])
->setSender('[email protected]', 'Someone')
->setTo('[email protected]')
->addTo('[email protected]')
->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.
```php
$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.
```php
$mergeVars = [
'firstname' => 'Foo',
'lastname' => 'Bar',
'title' => 'Good Title'
];
$email = new Email('elasticemail');
$emailInstance = $email->getTransport();
$emailInstance->setMergeVariables($mergeVars);
$email->setFrom(['[email protected]' => 'CakePHP Elastic Email'])
->setTo('[email protected]')
->setEmailFormat('both')
->setSubject('{title} - Email from CakePHP Elastic Email plugin')
->send('Hello {firstname} {lastname},
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.
```php
$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](https://github.com/sprintcube/cakephp-elastic-email/issues).