Email Emit Service (com.ibi.agents.XDEmailEmitAgent)

Syntax:

com.ibi.agents.XDEmailEmitAgent

iIT Service Object:

emit: Email Emit Agent

Description:

Emits an email to a specified mail host with various options, including the option to input data as an attachment.

Parameters:

Parameter

Description

Outgoing Mail Host *

Outgoing email host used to route outgoing email (add:port for non-standard port).

To *

Message recipient as an email address. Use a semicolon (;) to delimit multiple addresses.

Subject of Msg

Subject of the message.

Sender address

Sender of this email.

Copy To

Carbon copy recipient of this email. Use a semicolon (;) to delimit multiple addresses.

Blind Copy To

Blind Carbon copy recipient of this email. Use a semicolon (;) to delimit multiple addresses.

Reply-to

Address to reply to, for this email. Use semicolon (;) to delimit multiple addresses.

Content

Contains the data for the email body, default (blank) is the inbound document.

Attachment Tag

Tag name that holds a path to a file to be attached. This is an exact element name and not an XPATH expression. If the add_attachment tag is defined in the incoming XML document, then provide add_attachment as the value for this parameter and not the XPATH expression to the destination.

Add As Attachment

If set to true, the inbound document is treated as an attachment. An attachment name is then required.

Document Attachment Name

Name of the inbound document attachment.

Attachment Content Type

Content Type of the attachment.

User ID

Is the valid user ID to log on to the SMTP host server.

Password

Is a valid password to authenticate the SMTP user ID.

Content Type

The content type of the data.

Return

Select one of the following options from the drop-down list:

  • status. Status document will become the output document.
  • input. Input document will become the output document

Security Protocol

Select one of the following options from the drop-down list:

  • none - Clear SMTP connection.
  • SSLv2 - SMTPS - Connect to secure SMTP server.
  • STARTTLS - Connect to an unsecured SMTP server, then negotiate SSL/TLS connection.

Edges:

The following table lists the available line edges for the Email Emit Service (com.ibi.agents.XDEmailEmitAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_parse
  • fail_connect

Example:

To configure the Email Emit service, you must first specify the URL for your email server and the appropriate security level. The following example shows security settings that are configured for the Microsoft Exchange Server:

If your connection parameters are valid, you will receive an email notification that would context the incoming document and a response document from running the service, in the following format:

<?xml version="1.0" encoding="UTF-8" ?>
<emitStatus>
 <protocol>EMAIL</protocol>
 <parms>password=****, to=your_name@gmail.com, userid=js77777,
  docattachname=test.xml, usessl=STARTTLS, docattach=false,
  host=IBIUSMBSA.ibi.com, return=status, from=john.smith@ibi.com,
  subject=Email Emit Test</parms>
<status>0</status>
<msg />
<timestamp>2009-05-01T21:27:51.824Z</timestamp>
<attempts>1</attempts>
<name>your_name@gmail.com</name>
</emitStatus>

The following is an example of configuration settings for an Email Emit service object that includes an attachment in iIT Designer:

If your connection parameters are valid, you will receive an email attachment (test.doc) and a response document from running the service, in the following format:

<?xml version="1.0" encoding="UTF-8" ?>
<emitStatus>
 <protocol>EMAIL</protocol>
<parms>password=****, to=your_name@gmail.com, userid=js77777,
  docattachname=test.doc, usessl=STARTTLS, docattach=true,
  host=IBIUSMBSA.ibi.com, return=status, from=john.smith@ibi.com,
  subject=Email Emit Attch, docattachctype=text/plain, body=see
  attached</parms>
<status>0</status>
<msg />
<timestamp>2009-05-05T22:43:59.032Z</timestamp>
<attempts>1</attempts>
<name> your_name@gmail.com</name>
</emitStatus>