=== Plugin Name ===
Contributors: neerajmourya
Donate link: http://www.egrapes.in/
Tags: emails, custom emails
Requires at least: 4.0
Tested up to: 4.8
Stable tag: 4.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

A Plugin or framework for developers to add events to send customised email messages.

== Description ==

A Plugin or framework to add events to send customised email messages.
This also adds a user interface in wordpress's settings/options menu in wp admin to customise each event's email message. 
Subject and message text can be edited from user interface. Events can be added by filter ewee_events.

* This plugin does not provide any functionality alone. This can be requirement of other plugins and themes, as developer can use this as framework.

== Installation ==

1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.


== Frequently Asked Questions ==

= How to create an event group? =

Write the code in your theme's functions.php or your custom plugin's file.

add_filter('ewee_events_groups', 'custom_events_groups', 10, 1); //adding mail events groups
function custom_events_groups($events_groups){
    $events_groups['products'] = 'Products';
    return $events_groups;
}

= How to create an event? =

Write the code in your theme's functions.php or your custom plugin's file.

add_filter('ewee_events', 'custom_mail_events', 10, 1); //adding mail events
function custom_mail_events($events){
    $events['order_created'] = array(
        'name' => 'Order Created', //Name of the event.
        'description' => 'When order created.', //Description of the event.
        'send' => true, //Whether to use this event to send mail or not.
        'subject' => 'Order %orderno% Created.', //Subject of the message. can be modified from wp admin dashboard. Use token keys wrapped by %.
        'message' => 'An Order with Order No. %orderno% has been created.', //Message. can be modified from wp admin dashboard. Use token keys wrapped by %.
        'tokens' => array('orderno'), //Define tokens.
        'group' => 'products', //Event group.
    );
    return $events;
}

= How to trigger the event? =

Write the code in your theme's functions.php or your custom plugin's file when you want to send specific email.

Use send_mail method of EGrapesWPEmailsEvents class.

public function send_mail($event_key, $tokens = array(), $to, $headers = '', $attachments = array())

e.g.,

$eGrapesWPEmailsEvents = EGrapesWPEmailsEvents::get_instance(); //Get the object of class EGrapesWPEmailsEvents.
$eGrapesWPEmailsEvents->send_mail('order_created', array('orderno' => 'abc987'), 'abc@gmail.com'); //call the method send_mail.


== Screenshots ==

1. Email customization user interface in dashboard's settings options.

== Changelog ==

= 1.0.0 =
* Emails Events
* Emails Events groups.
* Emails customization user interface for specific events.