Email - attachment to file
Search form
Description - Writes the contents of an attachment to a file
Runtime Class - com.ibi.agents.XDAttachmentToFileAgent
Parameter Groups
Parameter Type Description
Sequence Number integer The number of the attachment to be retrieved. If specified, it takes precedence over the Content-ID.
Content-ID string The Content-ID of the attachment to be retrieved. Ignored if the Attachment Number is specified.
* - denotes required
Parameter Type Description
* Directory string The target output directory
* File Name string The output file name, use '*' to generate a unique timestamp
* - denotes required
Parameter Type Description
Output Encoding string Encoding 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 Decode boolean If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
* Respect Transactionality boolean If set, the emit respects the transactionality of the channel. If not set, the emit is always done.
Append boolean If set, the output will be appended to the file if it already exists
Append CRLF boolean If set, a line termination sequence will be written after the document
Emit Zero Length Files? boolean If true, emit empty files if the process creates them.
* - denotes required
Parameter Type Description
Output Document: string Whether 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: boolean Cleanup output document by deleting document attachment.
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDAttachmentToFileAgent
Parameter Groups
Parameter Type Description
Sequence Number integer The number of the attachment to be retrieved. If specified, it takes precedence over the Content-ID.
Content-ID string The Content-ID of the attachment to be retrieved. Ignored if the Attachment Number is specified.
* - denotes required
Parameter Type Description
* Directory string The target output directory
* File Name string The output file name, use '*' to generate a unique timestamp
* - denotes required
Parameter Type Description
Output Encoding string Encoding 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 Decode boolean If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
* Respect Transactionality boolean If set, the emit respects the transactionality of the channel. If not set, the emit is always done.
Append boolean If set, the output will be appended to the file if it already exists
Append CRLF boolean If set, a line termination sequence will be written after the document
Emit Zero Length Files? boolean If true, emit empty files if the process creates them.
* - denotes required
Parameter Type Description
Output Document: string Whether 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: boolean Cleanup output document by deleting document attachment.
* - denotes required
Output Events
Parameter Groups
Parameter | Type | Description | |
---|---|---|---|
Sequence Number | integer | The number of the attachment to be retrieved. If specified, it takes precedence over the Content-ID. | Content-ID | string | The Content-ID of the attachment to be retrieved. Ignored if the Attachment Number is specified. |
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
* | Directory | string | The target output directory | * | File Name | string | The output file name, use '*' to generate a unique timestamp |
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
Output Encoding | string | Encoding to apply to the output file being written. Does not apply when output is base 64.
Select from one of the following options:
|
Base64 Decode | boolean | If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified. | * | Respect Transactionality | boolean | If set, the emit respects the transactionality of the channel. If not set, the emit is always done. | Append | boolean | If set, the output will be appended to the file if it already exists | Append CRLF | boolean | If set, a line termination sequence will be written after the document | Emit Zero Length Files? | boolean | If true, emit empty files if the process creates them. |
* - denotes required
Parameter | Type | Description | |
---|---|---|---|
Output Document: | string | Whether output document emitted should be the original input document (original) or a status document (status)
Select from one of the following options:
|
Delete Attachment: | boolean | Cleanup output document by deleting document attachment. |
* - denotes required
Output Events
Name | Description |
---|---|
OnParseError | Could not parse a document. |
OnNotFound | The resource was not found and this is considered an error. |
OnFailedOperation | Could not perform the operation requested. |