The Simple Inbox Module

Answer

The Simple Inbox Module

The Simple Inbox module provides a functioning inbox that appears in the lower right-hand side of the screen. It is designed to work on both desktop and mobile browsers and shows a history of the ten most recently received messages. Its appearance may be configured by adding CSS style sheets with overriding rules to the pages on which it will be used.

Installation

To install the module, simply include the following <script> tag on your page:

<!-- Simple Inbox Module --><script src=http://cdn.xtify.com/reactor/1.4.2/modules/simple-inbox.min.js"> </script>

Message Delivery

By default all messages will be displayed normally as they are triggered and a copy will be silently placed in the inbox for later review. If user has the inbox open to read past messages and a new message arrives it will be added to the inbox rather than being displayed. If you would like to force a message not to appear in the inbox you may provide the following Custom Data in your campaign?s message:

{ "skipInbox" : true}

In contrast you may also specify that a message should not be shown normally but rather should be placed in the inbox even if it isn?t open. To achieve this you may provide the following Custom Data in your campaign?s message:

{ "inboxOnly" : true}

If the inboxOnly option is used the envelope icon on the inbox will glow light blue to indicate that a new message has arrived.

Message Expiration

Messages can be expired using one of two methods. An Expiration Date can be provided that will remove the message from the inbox at a specific date and time. This date / time must be provided using the?ISO 8601 standard format?as shown below:

{ "expirationDate":"2013-05-28T11:23-0500"}

Instead of an absolute date a time-to-live can be set. This is a time duration specified as a JSON object. It begins when a message is triggered and ends after the specified amount of time has elapsed. All of the fields in the timeToLive object are optional but at least one must be provided.

{? ? "timeToLive" : {? ? "ms" : 500? ? "seconds" : 30? ? "minutes" : 45? ? "hours" : 6? ? "days" : 2? ? "weeks" : 1? }}

If both an Expiration Date and Time-To-Live are provided the expiration date will take precedence.