What is the BC-Mail ?

The Petals Mail binding component is a bidirectional binding component, it allows to :

retrieve mails from an email account and send them to a JBI Service
send JBI messages to an email account

Component Configuration

Unable to render {include} Couldn't find a page to include called: 0 CDK Component Configuration Table

Definition of CDK parameter scope :

Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
Runtime: The paramater can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Attribute	Description	Default	Required
host	Define the smtp server address	-	Yes
port	Define the smtp server port	25	Yes
user	Define the username used for authentication	-	no
password	Define the password used for authentication	-	no

This parameter are useful only for dynamic exposition mode

Exposing a smtp connection as a service.

PROVIDE SERVICE : Import into the JBI environment an email account as a service, or use a generic SendMail service :

Petals Mail binding component allows JBI consumers to send mails to an email account. A JBI endpoint is registered into the JBI environment, and is linked to an smtp server, with an email address defined. When MailBC receives a message exchange from Petals platform, the content of the message is sent to the defined email address.

Sending mails

Step 1 : A JBI Consumer sends a Message Exchange to the Mail Binding Component.
Step 2 : Mail Binding Component processes the Message Exchange : transforms it into a mail message and retrieve targeted External Provider Service (email address) linked to the endpoint set in the Message Exchange.
Step 3 : Mail Binding Component sends this new mail to the targeted External Provider Service (Business Service, simple email account...).

Dynamic Exposition

The component can expose directly a generic SendMail service.To allow the component to provide his generic service, the component must have a wsdl with the name : component.wsdl. An example of this file is present in the component.To deactivate the generic service supplies by the component,simply erase the file : component.wsdl.The component parameter see below have to be defines(host, port, user, passwordl).Otherwise the component cannot know the technical information of the smtp server necessary for the generic sendMail service.
This service offer two mode :

In-Payload mode: The service allows the consumer to send a specific XML message to the component, which defines all the information needed to send an email.

The message send by the consumer has to respect the following definition:

<ns0:mail xmlns:ns0="http://petals.ow2.org/components/mail/version-3.0">
    <ns0:from>from@from.com</ns0:from>
    <ns0:reply>reply@reply.com</ns0:reply>
    <ns0:to>to@to.com</ns0:to>
    <ns0:subject>subject</ns0:subject>
    <ns0:body>Hello, here is an email</ns0:body>
</ns0:mail>

Out-Payload mode : The service allows the consumer to send a JBI message to the component by setting ws-addressing properties in the incoming message exchange which defines all the information needed to send an email.The content of the mail (body) is in the payload of the mesage.

Attribute	Description	Default	Required
Unknown macro: {http} To	email address of the recipient	-	Yes
Unknown macro: {http} From	email address of the sender	-	Yes
Unknown macro: {http} ReplyTo	email address for the reply	-	no
Unknown macro: {http} Action	the subject of the mail	petals-bc-mail	no

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 contain a provides node describing the link between an internal jbi endpoint and an external email address. Here is an exemple of jbi descriptor activating a new "provided 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">

        <!-- Import a Service into PEtALS => provides a Service. -->
        <jbi:provides
            interface-name="generatedNs:SendMail"
            service-name="generatedNs:SendMailService"
            endpoint-name="SendMailServiceEndpoint">

            <!-- CDK specific elements -->
            <petalsCDK:wsdl>sendMail.wsdl</petalsCDK:wsdl>

            <!-- Component specific elements -->
            <mail:scheme>smtp</mail:scheme>
            <mail:host>smtp.host.com</mail:host>
            <mail:port>25</mail:port>
            <mail:user>user</mail:user>
            <mail:password>password</mail:password>
            <mail:from>from email address</mail:from>
            <mail:reply>reply email address</mail:reply>
            <mail:to>recipient address</mail:to>
            <mail:subject>mail subject</mail:subject>
        </jbi:provides>
    </jbi:services>
</jbi:jbi>

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

Parameter	Description	Default	Required
provides	Describe the JBI service that will be exposed into the JBI bus. Interface (QName), Service (QName) and Endpoint (String) attributes are required.	-	Yes

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

Parameter	Description	Default	Required
timeout	Timeout in milliseconds of a synchronous send. This parameter is used by the method `sendSync` (Exchange exchange) proposes by the CDK `Listeners` classes. Set it to 0 for an infinite timeout.	30000	No
exchange-properties	This sections defines the list of properties to set to the JBI exchange when processing a service.	-	No
message-properties	This sections defines the list of properties to set to the JBI message when processing a service.	-	No
validate-wsdl	Activate the validation of the WSDL when deploying a service unit.	true	No
wsdl	Path to the WSDL document describing services and operations exposed by the provided JBI endpoints defined in the SU. The value of this parameter is : an URL a file relative to the root of the SU package If not specified, a basic WSDL description is automaticaly provided by the CDK.	-	No
forward-attachments	Defines if attachment will be forwarded from IN message to OUT message.	false	No
forward-message-properties	Defines if the message properties will be forwarded from IN message to OUT message.	false	No
forward-security-subject	Defines if the security subject will be forwarded from IN message to OUT message.	false	No

todo

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,
An optional wsdl file describing the related service

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

Usage

Once a provides node is configured, you can start to send email via the mail binding component. You just have to send message exchange to endpoints activated by service unit deployments (containing jbi.xml with provides node).

warning
InOnly or RobustInOnly message exchange patterns are allowed.

Invoking service on incoming email

CONSUME SERVICE : Expose an internal JBI service outside the JBI environment that can be accessed by sending mails to an email account :

Receiving mails

Petals Mail binding component (MailBC) allows to receive mails from external consumer and to bind them to message exchanges intinded to internal jbi components. To receive new mails, MailBC can be linked to specific mail stores. It will check these stores periodicaly to retrieve new mails. If it finds a new mail in a store, it will process it (map this mail to a message exchange) and send it to the targeted jbi endpoint. Then the mail is removed from the store. So, all mails (read or unread) in a store are considered as new mail.

Step 1 : An External Consumer Entity (Business Service or simple mail client) sends an email to the registered Mail Store (a classical email account).
Step 2 : Mail Binding Component periodicaly checks for new mails and imports them.
Step 3 and 4 : Mail Binding Component processes this new mails : transforms them into Message Exchanges, sends them to targeted jbi components (step 4) and finally delete them from the mail Store.

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

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

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.

The component sends exchange with the InOnly pattern only.

Table of contents