Imap-call
Description
Use this GreenVulcano® ESB plugin if you want to receive an email using IMAP protocol.
VulCon / GV Console Configuration
GreenVulcano® ESB allows you to receive emails using the imap-call plugin. Received messages are translated into an XML document that describes the content of the message and its attachments if presents.
The imap-call element is used by Channel and routed-call and has the following attributes:
| Attribute | Type | Description |
|---|---|---|
| type | fixed | This attribute must assume the value call. |
| class | fixed | This attribute must assume the value it.greenvulcano.gvesb.virtual.imap.IMAPCallOperation. |
| name | required | Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations. |
| jndi-name | required | JNDI name of the mail Session configured in the application server.
The mail Sessions can be configured using the file mail-service.xml present into the folder //GV_HOME/application/deploy |
| override-protocol-host | optional | Corresponds to the property mail.protocol.host and overwrites the value of property mail.host specified in the configuration of the mail Session. |
| override-protocol-user | optional | Corresponds to the property mail.protocol.user and overwrites the value of property mail.user specified in the configuration of the mail Session. |
| delete-messages | optional | Mark a processed message as DELETED. Default false. |
| expunge | optional | Expunge (permanently remove) messages marked DELETED. Default false. |
| email-rx-cleaner | optional | RegExp pattern for email address cleaning. Default "[A-z][A-z0-9_]*([.][A-z0-9_]+)*[@][A-z0-9_]+([.][A-z0-9_]+)*[.][A-z]{2,4}". |
| export-EML | optional | Also export a message in EML format. Default false. |
| max-read-messages | optional | Maximum number of emails to be read. Default 10, a value of -1 means read all. |
The imap-call configuration node may contain the following sub-elements
- Description
- JNDIHelper
- mail-properties
