Code Monkey home page Code Monkey logo

zf2-mail's Introduction

unjudder/mail

Email Module for Zendframework 2.

# Uj\Mail
Version 1.0-alpha2
Authors
License [BSD-3-Clause](https://github.com/unjudder/zf2-mail/blob/master/LICENSE.md License)

Overview

In most business applications you have to send many, different emails to your customers. On top of the zendframwork we provide an easy to use, config aware email - service module.

Features

  • Provide configurable core services (transport, renderer, email)
  • Render emails from templates
  • Easy to use api
$serviceLocator->get('Uj\Mail\Email')
	->send('module/nameOfEmailTpl', array(
		'to' => '[email protected]',
		'from' => '[email protected]',
		'subject' => 'What ever - Our Customer Services',
		// ... additional parameters to pass to view renderer
	));

Installation

The easiest way to install unjudder/mail is by using composer.

  • Add the following lines to your composer.json
"require": {
	"unjudder/mail": "1.0-alpha2"
}
  • Load the zf2 module, edit your config/application.config.php file:
'modules' => array(
	'Uj\Mail'
)

Usage

Configuration

The config is located in the nested config namespace

$config['uj']['mail'];

Uj\Mail\Transport

KeyTypeDescription
type string Transport class, lookup in \Zend\Mail\Transport\*. It must implement \Zend\Mail\Transport\TransportInterface.
options array A list of options that will be passed to the transport options instance.

To do

  • Improve the docs.
  • Add controller plugin
  • Add signature support
  • Add (more) template storage adapters, eg. database
  • Set Subject from within email template
  • Add attachments/mime parts from within email template
  • Add default email parameters (to, sender, ...)
  • Message Queue/Cli Tool for sending many mails in background

License

The files in this project are released under the unjudder license. Please find a copy of this license bundled with this package in the file LICENSE.md. Our License is also available through the web at: http://unjudder.com/license/new-bsd.

zf2-mail's People

Contributors

alrik avatar ojhaujjwal avatar mbman avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.