Jump to Content

Objective HTML

Postmaster

The definitive email solution for ExpressionEngine

Getting Started

The purpose of this tutorial is to get you familiar with what a parcel is and how it can help you and your clients. This document will dissect each component of a parcel and describe its purpose.

What is a Parcel?

A Parcel is a series of configurations that allow you to control who sends and receives the email, when to send the email, the template markup and EE tags, an email preview, and the service that send each email. Parcels allow you to create an unlimited number of configurations, so the possibilities are limitless.

Step 1. Overview

The first screen is the overview which outlines the parcels and utilities that are installed. For the sake of this tutorial, do not concern yourself with the Utilities section. To get started click the Create New Parcel button in the upper right hand corner.

fullscreen

Step 2. Defining the Sender/Recipient

float-right

After you clicked Create New Parcel, you should define who the email is being sent to, and who it is from. You can use dynamic and/or static values to populate these fields.

Use the parcel: prefix to access the channel data. To acecss the member data, use the member: prefix.

Step 3. Defining a channel

The next step is to define a channel. This will limit a parcel to a single channel. As you change the channel dropdown, the other options will change to correspond with the selected channel. For instance, only statuses, categories, and member groups will display that are assigned to the selected channel. If you find that you aren’t receiving emails when you think you should, be sure to double check these settings.

float-right

Configuration

Channel
Selecting a channel is required. This will be basis of all subsequent configurations.
Entry Trigger
The entry trigger determines when to send the email. If both New and Edit are selected, then the email will be sent for both new and edited entries (provided the other conditions are met).
Categories
You can select categories which will be used to send the email. If the entry matches any of the categories that are checked, then the email will be sent (provided the other conditions are met).
Statuses
You can use different statuses to determine when emails should be sent. If the entry belongs to any of the checked statuses, then the email will be sent (provided the other conditions are met).
Member Group
You can define members groups to determine when emails should be sent. If the author of the entry belongs to any of the checked member groups, then the email will be sent (provided the other conditions are met).

Step 4. Post dated emails and re-occurring emails

float-right

This step is totally optional, but it allows you post-date emails using specific and/or relative dates. Dates can be static and/or dynamic.

Configuration

Post Date Specific
This allows you to define a specific date in which to send a post-dated email. The date can be dynamic and/or static, but must be a specific date.
Post Date Relative
This allows you to define a human readable string of text to denote the length of time in the future an email should be sent. Example, “+1 day”, “+1 hour”, “+1 week”.
Send Every
This allows you to define a length of time to send a reoccuring emails. This should be a relative date similar to the “Post Date Relative” setting.

Step 5. Custom conditionals

float-right

This step is also optional, but allows you to define a proprietary conditional that will determine if an email should be sent. For instance, you can only send emails if a particular channel field contained specific values. Simply create your own conditional and output TRUE to send the email, and FALSE to prevent it from sending. If no value is present the field is ignored.

Step 6. Parcel preview

fullscreen

If you just created a channel and are trying to setup a new Parcel, be sure to have some sample data at your disposal, it makes creating parcels a lot easier. If you have an empty channel, before continuing be sure to create a test entry before creating your template.

float-right

Parse Entry Dropdown

Once you have some sample channel data populated, it will appear in the Parse Entry dropdown. You can select different options (entries) from this list to parse your template using various entries to test all the different scenarios. Each time you change the dropdown, the preview will update and re-render itself.

While this feature isn’t required, it’s highly recommended - it will save you a lot of time in the long run.

Step 7. Template Editor

fullscreen

We spent a lot of time on this interface, and we wanted to make sure it wasn’t just functional, but would save developers a lot of time. We also wanted to try to eliminate some of the pitfalls that are associated with creating email templates. All of your HTML, CSS, and EE tags will be rendered as you type. You will be able to fix coding errors on the fly, and quickly parse your data against multiple entries.

Features

float-right float-right
Syntax Highlighting
You can easily choose your own color schema that fits your coding style. This will improve your reading comprehension, thus making the process that much easier and faster. This means you will no longer dread creating email templates and trying to figure out how you are going to send them.
Refresh Preview
You can refresh the preview and re-render your code at any time by clicking the ‘Refresh Preview’ link. By default, the code will re-render itself within a defined length of time after typing. This preview rate can be adjusted to your preference.
Variable Reference
Gone are the days when you need to open up the channel fields screen just to remember your naming convention. Simply open the tab and a panel will display with all your channel fields. Clicking on them will output the tag on the cursor location in the template editor. Clicking the toggle will either add or remove the curly braces from the output.

Step 8. Subject

float-right

Simply type your email subject as desired. All the same template tags are available here, just as they are in the template editor. “If” statements, date formatting, custom fields ‐ are all accepted and parsed accordingly.

Step 9. Email Services

float-right

The final step is selecting which service is going to send your email. Each email service can fundamentally change the way a parcel works. With that said, all the rules that are outlined in this document are the for the default settings. Since Postmaster is so versatile and API driven, things can be changed at the desire of the developer on a case by case basis.

For instance, sending transaction email using ExpressionEngine’s email service utilizes all the to, cc, and bcc fields. Whereas MailChimp and CampaignMonitor ignore these fields entirely and send emails to entire lists of people that have previously subscribed.

Developer API’s

You can take things even further with the developer API’s. Documentation on this is coming soon.