imap-call

Plugin for receiving emails via IMAP protocol.

Fixed attributes:

  • class: Unmodifiable. Used by GreenVulcanoESB factory framework.
  • type: Unmodifiable. Used by GreenVulcanoESB factory framework.

Implied attributes:

  • sort-ascending: Mail sorting ascending direction. Default false.
  • max-read-messages: Maximum number of emails to be read. Default 10, a value of -1 means read all.
  • expunge: Expunge (permanently remove) messages marked DELETED. Default false.
  • delete-messages: Mark a processed message as DELETED. Default false.
  • export-EML: Also export a message in EML format. Default false.
  • override-protocol-user: Corresponds to the property mail.protocol.user and overwrites the value of property mail.user specified in the configuration of the mail Session.
  • jndi-name: JNDI name of the mail Session configured in the application server.
  • email-rx-cleaner: 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}”.
  • sort-field: Mail sorting criteria. Default ARRIVAL.
  • override-protocol-host: Corresponds to the property mail.protocol.host and overwrites the value of property mail.host specified in the configuration of the mail Session.

Required attributes:

  • name: Operation name. Used in the ‘Flow’ section to associate workflow nodes to VCL operations.

Subelements

imap-call has the followong subelements:

  • Description (optional).
  • JNDIHelper (optional).
  • mail-properties (optional).

mail-properties

The SMTP protocol provider supports the following properties, which may be set in the JavaMail Session object. The properties are always set as strings; the Type column describes how the string is interpreted. For example, use props.put(“mail.smtp.port”, “888”); to set the mail.smtp.port property, which is of type int. Note that if you’re using the “smtps” protocol to access SMTP over SSL, all the properties would be named “mail.smtps.*”.

Subelements

mail-properties has the followong subelement:

  • mail-property (at least one element).

mail-property

Name value pair that contains the properties to set.

Required attributes:

  • value: Property value. Can contains placeholder to be resolved at runtime.
  • name: Property name.