HomeGuidesRecipesAPI
HomeGuidesAPILog In

Send Email Action

Overview

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

Action Attributes

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
Address From Display NameEmails will display this name to the sender
Address ToEmails 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 LineThis will be the subject of 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.

🚧

Required Attributes

Address From, Address To, Email Body and Subject Line are all required for the action to successfully run.

📘

Note

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.

Description

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 article)
  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.

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.