Send an HTML email

Send an HTML email

You can send an HTML email without an attachment with the shortcut Output workflow component: Send an HTML email.

If you want an attachment, then you should consider the Create PDF email component instead.

 

The Send an HTML email workflow component has these parameters:

   

  

 

The fields are explained below:

 

Email to

  • The receiver(s) of the email. Multiple receivers should be separated with a semi colon (;).

Email subject

  • The subject of the email.

Mail template

  • It is recommended to use the .ifm HTML format as covered here.

  • The alternative is the .vm format as described below.

The mail template file (.vm) (UTF-8 encoded), that setup the layout of the contents of the email. In this file you can use variables setup in the workflow. Variables are referred to with a preceding $-sign.

 

Generates the HTML document for an e-mail body, based on an Apache Velocity template. The template must be uploaded in the "Mail templates" folder in the library.

In the Velocity template, you can use variables that will be replaced with metadata values (technically Camel header values). The "Set workflow variable" component can be used to set the values for the variables that are used in the mail template.

Notes

Note that Velocity variables must start with an alphabetic character (a .. z or A .. Z). The rest of the characters are limited to the following types of characters:

Alphabetic (a .. z, A .. Z)

Numeric (0 .. 9)

Hyphen ("-")

Underscore ("_")

For additional details of the Velocity format, see https://velocity.apache.org/engine/1.7/user-guide.html

Hold email

  • If you activate this option, then the email will not be sent directly, but will be generated in the status held in the email log. From the email log you can e.g. choose to download and open the email, release and send the email or to choose to delete the email from the email log.

  • You can not only set a fixed value for the hold email option, but you can also setup an XPath expression (activate it on the right) to decide if the email should be held or not. The XPath expression must return either of the values 'no' or 'yes'.

Email server

  • Here you need to refer to one of the email server (SMTP) definitions, that is setup in the InterFormNG2 configuration.


Include in e-mail log
  1. This setup if you want to (fully/partially or not at all) save the outgoing email in the email log. The options are:
    Full    : Save the complete email in the email log.
    Event: Save only the email event.
    Nothing: The email will not be saved in the email log.

Email from

  • The email address, that is setup as the sender of the email.

Email CC

  • Optional CC (Carbon Copy) receiver(s) of the email. Multiple receivers should be separated with a semi colon (;).

 

Email BCC

  • Optional BCC (Blind Carbon Copy) receiver(s). Multiple receivers should be separated with a semi colon (;).

 

Email reply to

  • The email address setup as the reply to address.


    • Related Articles

    • Render email HTML

      The workflow component, Render email HTML (which is an advanced create document workflow component) accepts XML as input and generates an HTML file, that e.g. can be saved into the file system with the to filesystem component. The Render email HTML ...

    • HTML

      HTML is one of the supported input and output file types/payloads in InterFormNG2. You can e.g. use html as an email template in e.g. the create PDF email and the create email message workflow components, and you can e.g. transform an input file into ...

    • Email input

      This section describes the various email inputs. Email input covers both the various payloads, that you can use when emailing, but it also includes the option to setup a workflow to monitor an email account for incoming emails. 1. Use an XML file or ...

    • Email body

      This section describes the options you have for setting up the body section of emails, that you send out with InterFormNG2. The body section of an email can be any of these: 1. An HTML template, that has been created in the InterFormNG2 designer One ...

    • Email output

      This section contains information about emailing from (and to) InterFormNG2. For the most email scenarios you would need to setup an email server and then use either of the workflow components, Create PDF email (if you want a standard PDF attachment) ...