unjudder/mail
Email Module for Zendframework 2., (*1)
# |
Uj\Mail |
| Version |
1.0-alpha2 |
| Authors |
License | [BSD-3-Clause](https://github.com/unjudder/zf2-mail/blob/master/LICENSE.md License), (*2)
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., (*3)
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' => 'customer@domain.tld',
'from' => 'service@your-service.tld',
'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., (*4)
- 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, (*5)
$config['uj']['mail'];
Uj\Mail\Transport
| Key |
Type |
Description |
| 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., (*6)