Skip to content

Commit

Permalink
Amend README
Browse files Browse the repository at this point in the history
  • Loading branch information
Emma Vandermeer committed Jul 2, 2017
1 parent 8e2af59 commit 3f2c56a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -2,7 +2,7 @@

Manage the automated delivery of custom emails, triggered by certain pre-determined events and conditions.

![Screenshot](resources/screenshots/courier_blueprints.png)
![Screenshot](courier/resources/screenshots/courier_blueprints.png)

## Requirements

Expand All @@ -23,19 +23,19 @@ Courier is a [Craft CMS](http://craftcms.com/) plugin that allows you to create
## Features

* Listen for any event (including core Craft CMS events or events triggered by a plugin), and conditionally send an email
* Create and manage Blueprints to configure email settings, and the conditions that should be met before an email is sent
* Create and manage Blueprints to configure email settings, and the conditions that should be met before an email is sent
* Craft global sets and event parameters are available for use with Twig in *most* of a Blueprint's settings fields
* Add multiple recipients to an email with the use of a Blueprint's CC and BCC fields.
* Complete control over email template structure, and where email template files should be sourced.
* Ability to use both HTML and Text email templates with each email.
* All email templates have access to the relevant Blueprint model, Craft global sets and any parameters made available on the event itself
* Track when emails were sent and view any errors that were raised while rendering or trying to send an email in the “Deliveries” section.

* Track when emails were sent and view any errors that were raised while rendering or trying to send an email in the “Deliveries” section.


## Settings
From the plugin settings page you can define which events you might watch for when setting up your Blueprints, and how many delivery records should be retained.

![Screenshot](resources/screenshots/courier_plugin-settings.png)
![Screenshot](courier/resources/screenshots/courier_plugin-settings.png)

### Craft CMS Email Settings

Expand Down Expand Up @@ -74,12 +74,12 @@ Which event(s) you want to trigger a Blueprint's email. Additional custom event
##### Event Trigger Conditions
Twig conditions to run after a watched event is fired.

* Have this field's code evaluate to a single `true` if you want the event to trigger the Blueprint's email.
* Have this field's code evaluate to a single `true` if you want the event to trigger the Blueprint's email.
* Have it evaluate to a single `false` if the blueprint should ignore the event.

You might have the Guest Entries plugin set up to accept front end submissions from guests, and save entries to a section with an ID of `11`. The screenshot below provides and example of how a Blueprint might be set up to send an email when a new entry is created in that section:

![Screenshot](resources/screenshots/courier_plugin_enquiry-alert--triggerconditions.png)
![Screenshot](courier/resources/screenshots/courier_plugin_enquiry-alert--triggerconditions.png)

## TODO

Expand Down

0 comments on commit 3f2c56a

Please sign in to comment.