View Source

{section}
{column}
h1. What is the BC-Mail ?

todo

h1. Component Configuration

todo

h1. Service Configuration

todo

h2. Send mails

todo

h3. Service Unit descriptor

todo

h3. Service Unit content

todo

h3. Usage

todo

h2. Receive mails

todo

h3. Service Unit descriptor

Petals Mail binding component can be configured by deploying a new service unit to it. The jbi descriptor (jbi.xml file) of this service unit must contains a consumes node describing the link between an external mail store and an internal jbi endpoint. Here is an exemple of jbi descriptor activating a new "consumed service" :

{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<!-- JBI descriptor for PEtALS' "petals-bc-mail" (Mail), version 3.0 -->
<jbi:jbi version="1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jbi="http://java.sun.com/xml/ns/jbi"
xmlns:mail="http://petals.ow2.org/components/mail/version-3.0"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
xmlns:generatedNs="http://test">

<!-- Import a Service into PEtALS or Expose a PEtALS Service => use a BC. -->
<jbi:services binding-component="true">

<!-- Expose a PEtALS Service => consumes a Service. -->
<jbi:consumes
interface-name="generatedNs:Interface"
service-name="generatedNs:Service"
endpoint-name="Endpoint">

<!-- CDK specific elements -->
<petalsCDK:operation>operation</petalsCDK:operation>
<petalsCDK:mep>InOnly</petalsCDK:mep>

<!-- Component specific elements -->
<mail:scheme>pop3</mail:scheme>
<mail:host>pop.host.com</mail:host>
<mail:port>110</mail:port>
<mail:user>user</mail:user>
<mail:password>password</mail:password>
<mail:folder>INBOX</mail:folder>
<mail:period>60000</mail:period>
</jbi:consumes>
</jbi:services>
</jbi:jbi>
{code}

\\
{include:0 CDK SU Consume Configuration}

\\
{table-plus}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (imap or pop3) | \- | Yes |
| username | the username used for authentication | \- | No |
| password | the password used for authentication. Can be null or empty | \- | No |
| host | the host used for connection | \- | Yes |
| port | the port used for connection | * imap : 143 \\ * pop3 : 110 | No |
| folder | the folder to check for new mails | INBOX | No |
| period | the checking period time | 60 000 ms | No |
| expunge | Expunge deleted messages (read messages are marked as DELETED, default is TRUE) | true | No |
{table-plus}

h3. Service Unit content

The Service Unit has to contain the following elements, packaged in an archive :
* The META-INF/jbi.xml descriptor file, has described above

{noformat}
su-mail.zip
+ META-INF
- jbi.xml
{noformat}

h3. Usage

When a new email is in the INBOX folder of the configured email account, the content of the mail is forwarded to the JBI Service defined in the Consumes section of the Service Unit.

{warning:title}
The component sends exchange with the InOnly pattern only.
{warning}

{column}
{column:width=350px}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}