Petals Documentation > Petals ESB > Petals Components > Page Comparison - Petals-BC-Mail (v.7 vs v.8)

Petals-BC-Mail

Version 7 by Charles Casadei
on Mar 20, 2010 15:19.
<< Changes from 6 to 7
compared with
Version 8 by Charles Casadei
on Mar 20, 2010 15:30.
Changes from 8 to 9 >>
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (20)

View Page History
...
h1. Service Configuration

h2. Send mails

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

...
{center}

# * 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...).

h2. Send mails
h3. Service Unit descriptor

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

h3. Service Unit descriptor
{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">

<!-- 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>
{code}

\\
{include:0 CDK SU Provide Configuration}

todo

h3. Service Unit content

todo
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

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

h3. Usage

todo
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:title=warning}
InOnly or RobustInOnly message exchange patterns are allowed.
{warning}

h2. Receive mails

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

{center}
!mail_in.png!
*Receiving mails*
{center}

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.


h3. Service Unit descriptor

...