README.md

koseven-awsmail

Amazon Simple Email Service (SES) enables you to send and receive email using a reliable and scalable email platform and Koseven Framework.

Jump To:

• Installation
• Configuration
• Message
• Utility
• Destinations
• Template

Requirements

Read the Amazon Simple Email Service documentation

• Access Key: https://console.aws.amazon.com/iam/home
• Developer Guide: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html
• Documentation: https://docs.aws.amazon.com/ses/index.html
• AWS SDK for PHP: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-php.html
• SDK API: https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html
• Credentials file: https://docs.aws.amazon.com/ses/latest/dg/create-shared-credentials-file.html

This module was tested using version 3.190.2

Installation

Place this module in your modules directory.

Copy MODPATH.koseven-awsmail/config/awsmail.php into APPPATH/config/awsmail.php and customize.

Activate the module in bootstrap.php.

<?php
Kohana::modules(array(
	...
	'awsmail' => MODPATH.'awsmail',
));

Configuration

• Access Key: Your access key (check link in Requirements). REQUIRED
• Secret Key: Your secret key (check link in Requirements). REQUIRED
• Region: Amazon SES is available in several AWS Regions around the world (check Developer Guide). REQUIRED
• Version: Version of the SDK library (you can use "latest" or "3.190.2"). REQUIRED
• Source Email: You can set a default source (from) for sending your emails. OPTIONAL (BLANK|NULL)
• Return Email: You can set a default email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. OPTIONAL (BLANK|NULL)
• Charset: Default charset. REQUIRED

APPPATH/config/awsmail.php

<?php
return [
	'credentials' => [
		'file' => [
			'path' => 'path/to/credentials',
			'profile' => 'default'
		],
		'access' => [
			'key' => 'Your access key',
			'secret' => 'Your secret key'
		]
	],
	'region' => 'us-east-1',
	'version' => 'latest',
	'source_email' => ['noreply@domain.com' => 'My Project Name'],
	'return_email' => ['bounce@domain.com' => ''],
	'charset' => 'UTF-8'
];

Here you can specify which credentials you want to use: using a file stored in your webserver or using the access key directly in the configuration file. You can use both at the same time, but using the file option is more secure.

[default]
aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY

Methods

Message

Example 1

$instance = AWSMail::message();
$instance->from('from@domain.com', 'Name from');
$instance->to('to@domain.com', 'Name to');
$instance->subject('This is the subject');
$instance->body('This is the content');
$result = $instance->send();
      
print_r($result);

Example 2

$instance = AWSMail::message();
$instance->from('from@domain.com', 'Name from');
$instance->to('to1@domain.com', 'Name to 1');
$instance->to('to2@domain.com', 'Name to 2');
$instance->cc('cc@domain.com', 'Name cc');
$instance->cc(array(
	'cc2@domain.com', 
	'cc3@domain.com', 
	'cc4@domain.com' => 'Name cc4'
));
$instance->bcc('bcc@domain.com', 'Name bcc');
$instance->reply_to('replyto@domain.com', 'Name reply to');
$instance->subject('This is the subject');
$instance->body('This is the content');
$result = $instance->send();

print_r($result);

Example 3

$file1 = 'dir/filename.ext';
$file2 = 'http://domain.com/page.html';
$file3 = 'This is the content of the attachment';

$instance = AWSMail::message();
$instance->from('from@domain.com', 'Name from');
$instance->to('to1@domain.com', 'Name to 1');
$instance->subject('This is the subject');
$instance->body('<p>This is the Html content</p>', 'This is the Text content');
$instance->attachment($file1, 'local_file.ext');
$instance->attachment($file2, 'external_file.html');
$instance->attachment($file3, 'text.txt');
$result = $instance->send();
      
print_r($result);

Utility

Create a template

$html = '<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>';
$text = 'Dear {{name}},\r\nYour favorite animal is {{favoriteanimal}}.';

$result = AWSMail::utility()->create_template('template_name', 'Greetings {{name}}', $html, $text);

print_r($result);

Update a template

$html = '<h1>Hello {{name}},</h1><p>Your favorite color is {{favoritecolor}}.</p>';
$text = 'Dear {{name}},\r\nYour favorite color is {{favoritecolor}}.';

$result = AWSMail::utility()->update_template('template_name', 'Greetings {{name}}', $html, $text);

print_r($result);

Get a template

$result = AWSMail::utility()->get_template('template_name');

print_r($result);

Delete a template

$result = AWSMail::utility()->delete_template('template_name');

print_r($result);

Destinations

Create a destination object

$destination1 = AWSMail::destinations();
$destination1->to('to@domain.com');
$destination1->data(array(
	'name' => 'My Name', 
	'favoritecolor' => 'Green'
));

$destination2 = AWSMail::destinations();
$destination2->to('to@domain.com');
$destination2->cc('cc@domain.com');
$destination2->data(array(
	'name' => 'My Other Name', 
	'favoritecolor' => 'Blue'
));

Template

You can send up to 50 destinations in a single call using a template

$template = AWSMail::template();
$template->name('tempalte_name');
$template->destination($destination1);
$template->destination($destination2);
$template->default_data(array('name' => 'Unknown', 'favoritecolor' => 'White'));
$result = $template->send();

print_r($result);

ABOUT AND LICENSE

Copyright (c) 2020, Soft Media Development. All right reserved.

This project is using the SDK from https://github.com/aws/aws-sdk-php created by Amazon Web Services.

This project is made under BSD license. See LICENSE file for more information.