IMAP4
The
IMAP4 component outputs messages from the specified IMAP4 server.
When transporting using a SSL protocol, the certificates registered by a management console are used, then the data will be transported following a public key infrastructure.
Stream Information
| Input | Format | All |
| Number of Inputs | 1 |
| Description |
The input stream is not used. Stream formats are not selectable.
|
| Output | Format | Text,MIME |
| Description |
If the output stream type is MIME, the entire message, including the mail header, is copied to the output stream.
If the output stream type is Text, the first text part of the message is copied to the output stream.
|
Component Properties
| Name | Data Type | Mapping | Description |
| Connection | connection | - |
The IMAP4 connection to use to connect to the server.
The connections are defined in the Connection Pane of Flow Designer or the Flow Service Management Console.
|
| Subject | string | Out |
This output-only property is set to the Subject field of the returned message.
In the case where the output stream holds multiple messages, it is set to the Subject field of the last message.
|
| To | string | Out |
This output-only property is set to the To field of the returned message.
In the case where the output stream holds multiple messages, it is set to the To field of the last message.
|
| From | string | Out |
This output-only property is set to the From field of the returned message.
In the case where the output stream holds multiple messages, it is set to the From field of the last message.
|
| Cc | string | Out |
This output-only property is set to the Cc field of the returned message.
In the case where the output stream holds multiple messages, it is set to the Cc field of the last message.
|
| LoopProcess | loopProcess | - |
Specifies if it outputs messages as an individual stream or as a single stream.
| true [true]
| - | Each message is returned in its own output stream.
|
| false [false]
| - | All messages are returned in a single output stream.
|
|
| Processing when commit | choice | - |
Specifies if messages are deleted on the server when the transaction is committed.
- Delete message from the server [true]
- Deletes messages on the server
- Do nothing [false]
- Do nothing
|
| MailHeaders | category | - |
Specifies the field values to get from the retrieved message. This property becomes a stream variable automatically. Thus, it can be used as a stream variable by following Mapper. For details of Stream variables, please refer to Stream Variables in Flow Service manual.
In the case where LoopProcess is set to false and the output stream holds multiple messages, the field values found in the last message are set.
|
Loop
If
LoopProcess=
true, separate output streams are created for each message, otherwise, a single output stream is created.
Transaction
| Commit | If Processing when commit=Delete message from the server, messages are deleted on the server. |
| Rollback | Do nothing |
Exceptions
| Type | Parameter | Stream for error handling flow | Error Code | Description |
| MailNotFoundException |
None
| This component's input stream |
-
| No messages in the mailbox. |
|
Exception
|
None
| This component's input stream |
-
| Cannot find the specified Connection. |
|
-
| Cannot connect to the IMAP4 server. |
|
-
| The IMAP4 server returns an error. |
Topic
- This component retrieves all the messages that exist in a mailbox irrespective of the state of a flag.
- When two or more IMAP4 clients (an IMAP4 component, mail client, etc.) connect simultaneously to the same mail box of the same account depending on mounting of an IMAP4 server, connection may be cut from a server. In this case this component returns error.