HomeGuidesAPI
HomeGuidesRecipesAPI
HomeGuidesAPILog In
Guides
These docs are for v16. Click to read the latest docs for v31.

Send Email Action

Suggest Edits

Overview

The Email action grants designers the ability to send email through their projects.

📘

Usage Policy for SmartIQ Email on Multi-tenant SaaS

During a work flow, Customer may only send emails that are part of the service communications of the transaction. All emails sent by the Customer as part of a SmartIQ deployment shall only be sent from the approved configured domain.

Customer warrants that it shall not send unsolicited or marketing communications from the Configured Email System.

Attributes

The following attributes are available on the action:

AttributeDescription
Address BCCEmails can be blind carbon copied to this email address
Address CCEmails can be carbon copied to this email address
Address FromEmails will appear to have originated from this address. If not provided the system default from Manage -> Settings will be used.
Address From Display NameEmails will display this name to the sender
Address To*Emails will be sent to this email address (Add one Address To attribute per Recipient)
Email BodyThis will populate the body of the email
Mht Body DocumentEmails can include one of the output documents in the form of HTML by inserting the name of the document in this Attribute. Note: Some filters classify MHT body emails as junk and should be avoided where possible
Reply ToEmails can be configured to have a return address to which replies to the message will go to.
Sanitise ContentBoolean value that determines if action strips unknown HTML. Use "true" or "false" (defaults to "true")
Subject Line*This will be the subject of the email

🚧

Required Attributes

Address To, Subject Line and a body attribute are required for the action to successfully run. Body attribute can be either Email Body or Mht Body Document.

Address From has a system default in Manage->Settings in addition to the attribute. At least one must be set.

📘

Multiple recipient lists

The To, CC, and BCC address parameters can be comma-separated lists of addresses, if desired. This can be combined with the join() function to allow a data-driven set of email recipients.

📘

Email Services and Requirements

Smart Communications encourages customers to bring their own email service whenever possible. This is the recommended solution due to the overarching benefits it provides companies. When using a third party email service, businesses can view and manage bounced emails, access open rates, and view tracking and analytics provided by the third party. These features are not available using Smart Communications as an email delivery service.

In multi-tenant environments there is a basic fallback service based on Amazon SES Email which will restrict the Address From at time of sending if changed from the default, email size is limited to 10MB and email statistics are unavailable. Customer Support can assist with configuration or further questions.

Usage

To add an email action:

  1. Add an Action to the Finish Page
  2. Select the Send Email action from the Type drop-down list and press OK
337
  1. The Send Email action will now be added to the finish page of your project.
  2. Select the Send Email action on the finish page
  3. Ensure that the Properties tab is selected
  4. Under the Action Attribute section, select an Attribute to assign a value to
  5. After selecting an Attribute, select a Type

The following are possible attribute types for the Send Email action:

  • Answer Value - The value of an Attribute can be populated from the answer field of a Question such as a User Prompt, Variable, etc.
  • Data Question - The value of an Attribute can be populated from the data fields within a Data Source
  • Text Value - The value of an Attribute can be set to a fixed, predetermined value. Note: Question references are supported within Text Value answers.
  1. Each Attribute must be added one at a time by selecting the Attribute, selecting a Type, setting or selecting a corresponding Text Value / Question and Answer, and then pressing the Add button
  2. The properties tab should resemble below
404
  1. Conditions may also be set on the Send Email action through the Conditions tab. Refer to Defining Conditions.
  2. To add a custom document from the project to be sent through the Send Email action, select the Documents tab
  3. Select the Custom radio button
  4. Select the Document that needs to be part of the email from the drop down list, and press Add
337
  1. Repeat Steps 12 and 13 for multiple document attachments.

🚧

Note

By default, all documents that are part of the project are included in the email.

Using .mht Body Document as an Email template

  1. Select the Send Email Action in Design.
  2. Select the _Body Document (Mht/Html) Action input and provide the Word Template name.
  3. Open the Action Documents panel.
88
  1. Select Custom.
  2. In the Document drop down menu, select the Word Document to be used as a .mht template.
  3. In the Format drop down, select MIME HTML File (mht).

📘

Troubleshooting

If you include constant value placeholders such as [ProjectLink] or [ProjectUrl] in the Word Document used to generate the mht file, you may find these are not correctly rendered when the project is run. This is an issue in Word where the spellchecker flags these as incorrectly spelt words (red squiggly line under the word) and this flagging in the saved file interferes with the placeholder replacement on document generation. To fix this problem, either disable spellchecking in Word before saving your document, or select the affected placeholders and right click and choose the Ignore All option from the spellchecking menu, then re save the file.

Send to Email Action - Failing

When the following error is received after Doc Gen:

535

Check the Management Console within SmartIQ Manage, for error messages that may assist you in troubleshooting the email failure.

Basic errors can be rectified by simply supplying mandatory Action Attributes in Design that are missing. You will receive errors such as:

511

In other cases, you may have set up your Action correctly within Design, but there might be some environmental issues that are causing your Email Action to fail:

511

As you can see, this error does not specify that the error is within your SmartIQ Action, it is simply stating that the: Send Email Action has failed, due to: “Failure sending mail”; this is, in fact, the error returned by the service being used to send the email.

In this case, if you have access to the appropriate Server, check that the SMTP services are set up correctly. See Installing SMTP service for further information.

Updated over 2 years ago