Difference between revisions of "Pop-call"
(Created page with "==Description== Use this plugin if you want to receive an email. =={{VULCON}} / {{GVCONSOLE}} Configuration== {{GVESB}} allows you to receive emails using the pop-call plugin. ...") |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | Use this plugin if you want to receive an email. | + | Use this {{GVESB}} plugin if you want to receive an email using POP3(S) protocol. |
=={{VULCON}} / {{GVCONSOLE}} Configuration== | =={{VULCON}} / {{GVCONSOLE}} Configuration== | ||
| − | {{GVESB}} allows you to receive emails using the pop-call plugin. Received messages are | + | {{GVESB}} allows you to receive emails using the pop-call plugin. Received messages are translated into an XML document that describes the content of the message and its attachments if presents. |
The pop-call element is used by [[Channel]] and [[routed-call]] and has the following attributes: | The pop-call element is used by [[Channel]] and [[routed-call]] and has the following attributes: | ||
| − | + | {|class="gvtable" | |
| − | + | ! Attribute !! Type !! Description | |
| − | + | |- | |
| − | + | | type || fixed || This attribute must assume the value '''call'''. | |
| − | + | |- | |
| − | + | | class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.pop.POPCallOperation'''. | |
| − | + | |- | |
| − | + | | 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. <br/> Default "[A-z][A-z0-9_]*([.][A-z0-9_]+)*[@][A-z0-9_]+([.][A-z0-9_]+)*[.][A-z]{2,4}". | ||
| + | |} | ||
| + | <div class="version_ge3.4"> | ||
| + | {|class="gvtable" | ||
| + | ! Attribute !! Type !! Description | ||
| + | |- | ||
| + | | export-EML || optional || Also export a message in EML format. Default false. | ||
| + | |} | ||
| + | </div> | ||
| + | <div class="version_ge3.3.5,3.4.10"> | ||
| + | {|class="gvtable" | ||
| + | ! Attribute !! Type !! Description | ||
| + | |- | ||
| + | | max-read-messages || optional || Maximum number of emails to be read. Default 10, a value of -1 means read all. | ||
| + | |} | ||
| + | </div> | ||
| − | Into pop-call can | + | Into pop-call can contains the following subelements |
* Description | * Description | ||
* [[JNDIHelper]] | * [[JNDIHelper]] | ||
* [[mail-properties]] | * [[mail-properties]] | ||
Latest revision as of 07:31, 29 February 2016
Description
Use this GreenVulcano® ESB plugin if you want to receive an email using POP3(S) protocol.
VulCon / GV Console Configuration
GreenVulcano® ESB allows you to receive emails using the pop-call plugin. Received messages are translated into an XML document that describes the content of the message and its attachments if presents.
The pop-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.pop.POPCallOperation. |
| 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}". |
| Attribute | Type | Description |
|---|---|---|
| export-EML | optional | Also export a message in EML format. Default false. |
| Attribute | Type | Description |
|---|---|---|
| max-read-messages | optional | Maximum number of emails to be read. Default 10, a value of -1 means read all. |
Into pop-call can contains the following subelements
- Description
- JNDIHelper
- mail-properties
