AV4TAr / MyZend_Email

ZF2 Email module - html emails with layouts and templates

MyZend / Email

Version 0.9

Introduction

MyZend Email is a ZF2 module to manage the process of sending emails with templates.

It encapsulates Zend\Mail\Message to keep it a simple use.

This module uses

• html email body with templates
• subject with templates
• txt email body with templates (alternative to html)

Install

Every module will have its own email templates. (Replace Application with your module name) module/Application/config/module.config.php

	'email' => array(
		"template_path_stack" => array(
				__DIR__ . "/../view/email/"
		),
	),

Add this structure to you module

	module/Application/view/email/html/your-module/*
	module/Application/view/email/subject/your-module/*
	module/Application/view/email/txt/your-module/*

Override the default layout with

	module/Application/view/email/layout/html/layout.phtml
	module/Application/view/email/layout/txt/layout.phtml

Setup your config under config/autoload folder module.email.local.php

return array(
	'email' => array(
		"active" => true,
		"defaults" => array(
				"layout_name" => "layout",
				"from_email" => "[e-mail]",
				"from_name" => "MyZend Project"
		),
		"emails" => array(
			"support" => "[e-mail]",
			"admin" => "[e-mail]"
		),
		'template_vars' => array(
			"company" => "MyZend Project",
			"slogan" => "",
			"baseUrl" => "http://www.yourproject.com"
		)
	)
);

Examples

/*
 * Basic use
 */
$email = $this->email->create();
$email->addTo("[e-mail]", "Ignacio Pascual");
$this->email->send($email);

/*
 * Admin mail
 */
$email = $this->email->create(array("html_content" => "this is a notice", "subject" => "error"));
$this->email->send($email);

/*
 * Using template variables
 */
$email = $this->email->create(array(
							"name" => "I. Pascual",
							"location" => "Barcelona"
						));
$email->setTemplateName("welcome");
$email->addTo("[e-mail]", "Ignacio Pascual");
$this->email->send($email);

/**
 * Without templates
 */
$email = $this->email->create();
$email->setSubject("Test");
$email->setTextContent("Hi, this is a test!");
$email->setHtmlContent("<h1>Hi,</h1> <p>this is a test!</p>");
$email->addTo("[e-mail]", "Ignacio Pascual");
$this->email->send($email);

/*
 * Optional arguments
 */
$email = $this->email->create();
$email->addTo("[e-mail]", "Ignacio Pascual");

//From
$email->setFrom("[e-mail]");
$email->setFromName("Do-Not-Reply");
//ReplyTo
$email->setReplyTo("[e-mail]");
$email->setReplyToName("Support Team");
//Layout
$email->setLayoutName("1column");
//Template
$email->setTemplateName("welcome");
//To
$email->addTo("[e-mail]", "Mr. Other Recipient");
//Cc
$email->addCc("[e-mail]", "Mr. Copy Recipient");
//Bcc
$email->addBcc("[e-mail]", "Mr.Not Revealing");
		
$this->email->send($email);