Share Assets via Email

Table of Contents

    Description

    IntuiFace supports two methods for sending emails from within your interactive experience. Both support the attachment of one or more images, videos, audio files and documents or snapshots of annotated images and scenes.

    • Method One: Hosted: Free email service offered by IntuiLab. You can customize every aspect of the email but :

      1. The FROM field contains a do-not-reply email address - donotreply@mail-intuiface.com - whose display name is that of the IntuiFace license holder. This cannot be changed.
      2. A short signature indicating your use of IntuiFace - Sent from an interactive experience built using IntuiFace. - is inserted at the very end: This cannot be changed.
      3. The attachment size is limited to 5MB.
    • Method Two: Configurable (Windows only): Use any SMTP server. No IntuiFace signature is appended to emails. No attachment size limitation (it defaults to 10MB but you can change this). You must be in possession of at least one Composer Enterprise license to use this option.

    The following table identifies which method is available for each edition of Composer and Player. In addition, this table highlights the daily limit for emails sent by Free Edition experiences.


    Adding Email Support to Your Experience

    To use either email method in an experience, add the appropriate interface to your experience:

    The Hosted version is ready for use out of the box. The Configurable version requires entry - via the Properties panel - of information specific to your email server. Remember, only Enterprise Edition customers can use the Configurable method.

    Preparing for Use of the Configurable Email Option

    Fill out all fields in the Properties panel for the Configurable Email IA. This information will be applied to all emails sent by IntuiFace.

    The Configurable email option requires use of ports 25 or 587. Make sure one of those ports are open for use by IntuiFace. For secure email, IntuiFace uses TSL via port 587; the use of SSL via port 465 is not supported.

    Using a Gmail SMTP server without "two step verification"

    If using Gmail without two step verification, the security settings of your SMTP server (smtp.gmail.com) may prevent use of Port 587. To make it work with Port 587, you must reduce the security level of the Gmail account to "less secure". For more information about changing Gmail security parameters, have a look at this article: https://support.google.com/accounts/answer/6010255

    Using a Gmail SMTP server with "two step verification"

    To send an email using a Gmail account with two step verification, you must generate an app password for use in IntuiFace:

    1. Visit your App passwords page. You may be asked to sign into your Google account.
    2. At the bottom, choose Other for the "Select app" option and type in IntuiFace. (You can type any text you wish, just use something to remind you that this password is being used in IntuiFace.)
    3. Click the "Generate" button. A password is generated.
    4. Copy the password and click on the "Done" button
    5. Paste this password into the "Password" property of the Configurable Email interface assets used in your IntuiFace experiences. NOTE: Be sure the value of the "Username" property is associated with the email address used to generate the password.

    Google documentation about how to generate an app password is here.

    Creating an Email without Attachments

    Each email interface asset has a Send action with configurable To, Subject and Body fields. Complete these fields as your needs require. You can use HTML mark-up in the Body field. Then simply call this Send action using one or more triggers you select.

    If using the Configurable Email IA, values such as 'Reply-to Address' and 'Reply-to Name' are derived from the properties set for it. See this section for a look at all available properties.

    Sharing-Send.jpg

    Creating an Email with Attachments

    You can attach images, videos, audio files and documents to emails. You can also attach annotated images and scenes.

    The steps for creating an email with attachments is identical to that followed for emails without attachments, discussed here. The difference comes from use of the sharing queue.

    To email attachments, you must add them to the sharing queue. Every item in the sharing queue is automatically attached to every email sent by IntuiFace. In fact, if there are items in the sharing queue, it is not possible to send an email without attachments.

    There are two ways to add Image, Video, Audio and Document assets into the sharing queue:

    1. Enable the Show sharing button property in the Tools section of the More Properties panel for the asset you may want to email.



      By touching this button in a running experience, the asset is added to the sharing queue.



      NOTE: Annotated images and scenes are added to the sharing queue by using the Snapshot button in the Drawing Tool. After annotating your images, click the snapshot button (see image below). A copy - the snapshot - is created. Press the Sharing button on this copy.



    2. Call the "Add in sharing queue" action of the Asset. You can call this action using any IntuiFace trigger. A parameter of this action is specification of which sharing queue to use.



      NOTE: Use the "Remove from sharing queue" trigger to remove this particular asset from a specified sharing queue.

    Creating an email body using multiple inputs

    If you have several inputs to use to create an email body, like several form inputs, you can use the Text Manipulation Interface Asset and its various methods.

    Basic example with the Concatenate action

    To build a quite basic email body with raw text, you can use the Concatenate action of Text Manipulation. Call the action as many times as needed, either binding the parameter on an input from the scene or adding fixed text like separators. You can use <br/>to create a line break.
    Don't forget to call the Clear action of the Text manipulation after sending the email

    EmailBodyConcat.jpg

    You can click on this link to download the sample described above

    HTML example with the Replace action

    To build a nicer email, you can:

    • Create an HTML body and put it in a hidden text on the scene. Use some placeholders as {EMAIL} in the HTML to make it easy to replace afterwards
    • Bind the Original text property of the Text Manipulation on this hidden text.
    • Call the Replace action to replace the placeholders with inputs coming from the scene or any data source such as an Excel file.

    Advanced example using a custom JavaScript Interface Asset

    The Shopping List Interface Asset used in the DIY SHopping Catalog sample is not only handling the business logic rules of a shopping cart but also generates the proper email body based on the selected items.
    Download the sample and have a look at the JavaScript file named ShoppingCart.js to see how it works.

    More About Sharing Queues

    Each sharing interface asset - email, file system, USB drive - has its own sharing queue. However, the above methods will add assets and asset snapshots to all sharing queues at the same time. To add an asset to a specific sharing queue, call that asset's Add in sharing queue action and specify which queue you are targeting.


    Sharing-AddToQueue.jpg

    If you would like to see the sharing queue as items are added/removed and even automate the Send action, add the Share via Email data template we've built for you by double-clicking the interface asset in the Interface Asset panel.

    Sharing-panel.jpg

    This data template illustrates what is possible with the Share via Email interface asset; you are not required to use its design or even to use it at all. The image on the right of the template simply illustrates placement of the sharing button.

    Sharing-DA.jpg

    Properties, Triggers & Actions

    Properties

    Common properties for Share via Email - Hosted and Share via Email - Configurable

    • Sharing storage unit: Unit used for size of the sharing queue

    Specific properties of Share via Email - Configurable

    • SMTP Server
    • SMTP Port
    • Username: Login of the SMTP user account
    • Password: Password of the SMTP user account
    • From address: Mail address of the sender (if supported by the SMTP server)
    • From name: 'Displayed name for the sender of the email (if supported by the SMTP server)
    • Reply-to address: Email address for reply-to
    • Reply-to name: Displayed name for the reply-to address
    • Maximum attachment size (MB)

    Triggers

    Email

    Common triggers for Share via Email - Hosted and Share via Email - Configurable

    • Email error: Raised when attempt to send the email fails. Contains the following read-only parameters
      • Error message
    • Email is too big: Raised when the attachements of the email exceeds the maximum size.
    • Email sent: Raised when email is successfully sent.

    Specific properties of Share via Email - Configurable

    • Free email quota exceeded (10 a day): Raised when the quota of 10 mails a day for FREE Composer has been reached**

    Sharing queue

    Common triggers for Share via Email - Hosted and Share via Email - Configurable

    • Sharing queue cleared: Raised when sharing queue selection is cleared.
    • Sharing queue item added: Raised when an item has been added to the sharing queue.
    • Sharing queue item removed: Raised when an item has been added to the sharing queue.

    Email-trigger.jpg

    Actions

    Share via Email - Hosted / Configurable

    • Send: send an email. Contains the following parameters:
      • To: target of the email
      • Subject: Subject of the email
      • Body: Body of the email

    Sharing queue

    • Add item to sharing queue: Add the item referenced by the following URI to the sharing queue.
      • URI: the local path the item to add to the sharing queue.
    • Clear sharing queue: Clear the sharing queue of all items.
    • Remove item from sharing queue: Remove the item referenced by the following URI from the sharing queue.
      • URI: the local path the item to add to the sharing queue.

    Sharingqueue.jpg