email connector

Description - Emits email to host:port with various options including input data as attachment

Runtime Class - com.ibi.agents.XDEmailEmitAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*To:stringThe destination address of this email. Use ';' to delimit multiple addresses.
From:stringThe senders email address.
Subject:stringThe subject of this email.
Cc:stringEmail address to carbon copy to. Use ';' to delimit multiple addresses.
Bcc:stringEmail address to send a blind copy to. Use ';' to delimit multiple addresses.
Reply To:stringAddress to replyto for this email. Use ';' to delimit multiple addresses.
* - denotes required
 ParameterTypeDescription
Body:stringSets the emails message body. If not set, the incoming document will be uses as the message body.
Content Type:stringMIME Type of the email

Select from one of the following options:
  • application/csv
  • application/json
  • application/pdf
  • application/x-compressed
  • application/xml
  • application/zip
  • binary/octet-stream
  • image/gif
  • image/jpg
  • image/png
  • multipart/x-zip
  • text/css
  • text/csv
  • text/html
  • text/javascript
  • text/json
  • text/plain
  • text/xhtml
  • text/xml
* - denotes required
 ParameterTypeDescription
Register Name:stringA register which contains additional email headers to be included in the email.
* - denotes required
 ParameterTypeDescription
Priority:stringMarks the priority of the outgoing email.

Select from one of the following options:
  • Highest (1) {1} - Highest email priority
  • Normal (3) {3} - Normal email priority
  • Lowest (5) {5} - Lowest email priority
Sensitivity:stringMarks the sensitivity of the outgoing email.

Select from one of the following options:
  • Normal {normal} - Normal Sensitivity
  • Personal {personal} - Personal Sensitivity
  • Private {private} - Private Sensitivity
  • Confidential {company-confidential} - Confidential Sensitivity
* - denotes required
 ParameterTypeDescription
Name:stringName of email attachment. (Required when adding an email attachment)
Content Type:stringMIME Type of the attachment.

Select from one of the following options:
  • application/csv
  • application/json
  • application/pdf
  • application/x-compressed
  • application/xml
  • application/zip
  • binary/octet-stream
  • image/gif
  • image/jpg
  • image/png
  • multipart/x-zip
  • text/css
  • text/csv
  • text/html
  • text/javascript
  • text/json
  • text/plain
  • text/xhtml
  • text/xml
File Attachment:stringInput document tag name that holds a path to a file to be attached.
Document Attachment:booleanIf true, the inbound document is treated as an attachment.
* - denotes required
 ParameterTypeDescription
Output Document:stringSets the outbound document of this object.

Select from one of the following options:
  • Status document {status} - Returns a status document.
  • Input document {input} - Returns the input document of the object.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
Description - Makes the body of a document into an attachment

Runtime Class - com.ibi.agents.XDAttachmentFromDocAgent



Parameter Groups

 ParameterTypeDescription
*Attachment Name:stringName of the attachment as seen in the email.'
Content-Type:stringThe MIME type; if omitted one is generated based on data format

Select from one of the following options:
  • application/csv
  • application/json
  • application/pdf
  • application/x-compressed
  • application/xml
  • application/zip
  • binary/octet-stream
  • image/gif
  • image/jpg
  • image/png
  • multipart/x-zip
  • text/css
  • text/csv
  • text/html
  • text/javascript
  • text/json
  • text/plain
  • text/xhtml
  • text/xml
* - denotes required
 ParameterTypeDescription
*Output Document:stringSets the output document of this object.

Select from one of the following options:
  • Input document {input} - Returns the input document.
  • Empty document {empty} - Returns a null or empty document.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
fail_attachCould not perform the operation requested.
Description - Delete a specified attachment.

Runtime Class - com.ibi.agents.XDAttachOps



Parameter Groups

 ParameterTypeDescription
*Index:stringIdentifies a single attachment using a 0 based index.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found and this is considered an error.
Description - Delete a specified attachment.

Runtime Class - com.ibi.agents.XDAttachOps



Parameter Groups

 ParameterTypeDescription
*Content-ID:stringIdentifies a single attachment using the content-id of an attachment. (Angle brackets need to be excluded)
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found and this is considered an error.
Description - Delete all attachments

Runtime Class - com.ibi.agents.XDAttachOps



Parameter Groups

 ParameterTypeDescription
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found and this is considered an error.
Description - Writes the contents of an attachment to a file

Runtime Class - com.ibi.agents.XDAttachmentToFileAgent



Parameter Groups

 ParameterTypeDescription
Sequence NumberintegerThe number of the attachment to be retrieved. If specified, it takes precedence over the Content-ID.
Content-IDstringThe Content-ID of the attachment to be retrieved. Ignored if the Attachment Number is specified.
* - denotes required
 ParameterTypeDescription
*DirectorystringThe target output directory
*File NamestringThe output file name, use '*' to generate a unique timestamp
* - denotes required
 ParameterTypeDescription
Output Encoding stringEncoding to apply to the output file being written. Does not apply when output is base 64.

Select from one of the following options:
  • Leave {leave} - Make no changes (input document carries encoding)
  • Platform {platform} - Use platform's encoding, not inbound message encoding
  • US-ASCII - Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set
  • CP-037/EBCDIC {CP037} - Eight bit EBCDIC encoding
  • ISO-8859-1 - ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1
  • UTF-8 - Eight-bit UCS Transformation Format
  • UTF16-BE {UTF-16BE} - Sixteen-bit UCS Transformation Format, big-endian byte order
  • UTF16-LE {UTF-16LE} - Sixteen-bit UCS Transformation Format, little-endian byte order
  • UTF16 {UTF-16} - Sixteen-bit UCS Transformation Format, byte order identified by [optional] byte order mark
Base64 DecodebooleanIf set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
*Respect TransactionalitybooleanIf set, the emit respects the transactionality of the channel. If not set, the emit is always done.
AppendbooleanIf set, the output will be appended to the file if it already exists
Append CRLFbooleanIf set, a line termination sequence will be written after the document
Emit Zero Length Files?booleanIf true, emit empty files if the process creates them.
* - denotes required
 ParameterTypeDescription
Output Document:stringWhether output document emitted should be the original input document (original) or a status document (status)

Select from one of the following options:
  • Status document {status} - Return a status document.
  • Input document {input} - Return the input document.
Delete Attachment:booleanCleanup output document by deleting document attachment.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnNotFoundThe resource was not found and this is considered an error.
OnFailedOperationCould not perform the operation requested.
Description - Finds an attachment and makes it the body of the document

Runtime Class - com.ibi.agents.XDAttachmentToDocAgent



Parameter Groups

 ParameterTypeDescription
Number:stringIdentifies a single attachment using a 0 based index. If set, takes precedence over the Content-ID.
Content-ID:stringIdentifies a single attachment using the content-id of an attachment. (Angle brackets need to be excluded)
* - denotes required
 ParameterTypeDescription
Keep Flat:booleanKeep the body of the document as an array of bytes.
* - denotes required
 ParameterTypeDescription
Body:stringRegister to store MIME headers for the main body.
Attachment:stringRegister to store MIME headers for the attachment.
* - denotes required
 ParameterTypeDescription
Delete Attachment:booleanDelete the attachment after it becomes the body of the document.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnNotFoundThe resource was not found and this is considered an error.
OnFailedOperationCould not perform the operation requested.
Description - Adds an attachment from the contents of a file

Runtime Class - com.ibi.agents.XDAddAttachmentFromFileAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringFile Path to the attachment.
* - denotes required
 ParameterTypeDescription
Attachment Name:stringName of the attachment as seen in the email.
*Content-Type:stringValue of the Content-Type MIME Header

Select from one of the following options:
  • application/csv
  • application/json
  • application/pdf
  • application/x-compressed
  • application/xml
  • application/zip
  • binary/octet-stream
  • image/gif
  • image/jpg
  • image/png
  • multipart/x-zip
  • text/css
  • text/csv
  • text/html
  • text/javascript
  • text/json
  • text/plain
  • text/xhtml
  • text/xml
* - denotes required
 ParameterTypeDescription
Content-Transfer-Encoding:stringValue of the Content-Transfer-Encoding MIME Header

Select from one of the following options:
  • base64 - Specify content-transfer-encoding as base64
  • binary - Specify content-transfer-encoding as binary
Content-Description:stringValue of the Content-Description MIME Header
Content-Disposition:stringValue of the Content-Disposition MIME Header

Select from one of the following options:
  • attachment; filename=Attachment_File_Name;
Content-ID:stringValue of the Content-ID MIME Header
* - denotes required
 ParameterTypeDescription
Set MIME Headers:stringName of register which is used to add additional MIME headers for the attachment.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
Description - Adds an attachment
 
Runtime Class - com.ibi.agents.XDAddAttachmentAgent


 

Parameter Groups

  Parameter Type Description
* Content: string A value or expression which provides the contents of the attachment
* Content-Type: string Value of the Content-Type MIME Header

Select from one of the following options:
  • application/csv
  • application/json
  • application/pdf
  • application/x-compressed
  • application/xml
  • application/zip
  • binary/octet-stream
  • image/gif
  • image/jpg
  • image/png
  • multipart/x-zip
  • text/css
  • text/csv
  • text/html
  • text/javascript
  • text/json
  • text/plain
  • text/xhtml
  • text/xml
  Character Set: string The charset used to convert from Java characters to an array of bytes. If absent, the default character set will be used.

Select from one of the following options:
  • US-ASCII - Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set
  • ISO-8859-1 - ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1
  • UTF-8 - Eight-bit UCS Transformation Format
  • UTF-16BE - Sixteen-bit UCS Transformation Format, big-endian byte order
  • UTF-16LE - Sixteen-bit UCS Transformation Format, little-endian byte order
  • UTF-16 - Sixteen-bit UCS Transformation Format, byte order identified by an optional byte-order mark
* - denotes required
  Parameter Type Description
  Attachment Name: string Name of attachment as seen in the email.
* - denotes required
  Parameter Type Description
  Content-Transfer-Encoding: string Value of the Content-Transfer-Encoding MIME Header

Select from one of the following options:
  • base64 - Specify content-transfer-encoding as base64
  • binary - Specify content-transfer-encoding as binary
  Content-Description: string Value of the Content-Description MIME Header
  Content-Disposition: string Value of the Content-Disposition MIME Header

Select from one of the following options:
  • attachment; filename=Attachment_File_Name;
  Content-ID: string Value of the Content-ID MIME Header
* - denotes required
  Parameter Type Description
  Set MIME Headers: string Name of register which is used to add additional MIME headers for the attachment.
* - denotes required

 

Output Events

 

Name Description
OnParseError Could not parse a document.