What is the BC-Mail ?

todo

Component Configuration

todo

Service Configuration

todo

Send mails

todo

Service Unit descriptor

todo

Service Unit content

todo

Usage

todo

Receive mails

todo

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" :

<?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>

Configuration of a Service Unit to consume a service (JBI)

Parameter	Description	Default	Required
consumes	Refer JBI service to invoke into the JBI bus. You can define an explicit endpoint: interface (QName) / Service (QName) / Endpoint (String) attributes. Or define implicit endpoint, to let the container routing according to QOS configurations (HA...): -by Interface attribute (QName) -by Service attribute (QName)	-	Yes

Configuration of a Service Unit to consume a service (CDK)

Parameter	Description	Default	Required
mep	Message exchange pattern abbreviation. This parameter can be used in conjunction with the method of the CDK Listeners: `createMessageExchange(Extensions extensions)`. This method returns a CDK Exchange corresponding to the type of the specified pattern.	-	Yes
operation	Operation to call on a service. This parameter can be used in conjunction with the sending methods of the Listeners. If no operation is specified in the Message Exchange to send, this parameter will be used.	-	No
timeout	Timeout in milliseconds of a synchronous send. This parameter can be used in conjunction with the sendSync(Exchange exchange) method of the Listeners. Set 0 for an infinite timeout.	30000	No

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

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

su-mail.zip
   + META-INF
     - jbi.xml

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.