{section}
{column}
h1. Exposing a SMTP transfer as a service. (Provides mode)
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.
\\
{center} !Petals-BC-Mail 3.2.x^schema_provide.png|border=0,width=500,height=259!
*Sending mails{*}{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. Dynamic Exposition
The component can expose directly a generic SendMail service without deploying a service unit.
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.
Parameters (host, port, user, passwordl) have to be defined at component level (cf section *Component Configuration*), otherwise the component can not 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:
{code:lang=xml}
<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>
{code}
* 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 ||
| \{\[http://www.w3.org/2005/08/addressing\]}To | email address of the recipient | {center}\-{center} | {center}Yes{center} |
| \{\[http://www.w3.org/2005/08/addressing\]}From | email address of the sender | {center}\-{center} | {center}Yes{center} |
| \{\[http://www.w3.org/2005/08/addressing\]}ReplyTo | email address for the reply | {center}\-{center} | {center}no{center} |
| \{\[http://www.w3.org/2005/08/addressing\]}Action | the subject of the mail | {center}petals-bc-mail{center} | {center}no{center} |
h2. Static exposition
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.
h3. 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).
The IN message looks like :
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<mail>[#5]mail by using service unit</mail>
{code}
{warning:title=warning}
InOnly message exchange patterns are allowed.
{warning}
h3. Configuration
h4. 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}
\\
{center}{*}Configuration of a Service Unit to provide a service (Mail)*{center}
{table-plus}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (smtp) | {center}\-{center} | {center}Yes{center} |
| username | the username used for authentication | {center}\-{center} | {center}No{center} |
| password | the password used for authentication. Can be null or empty | {center}\-{center} | {center}No{center} |
| host | the host used for connection | {center}\-{center} | {center}Yes{center} |
| port | the port used for connection | {center}\-{center} | {center}Yes{center} |
| to | email address of the recipient | {center}\-{center} | {center}Yes{center} |
| from | email address of the sender | {center}\-{center} | {center}Yes{center} |
| reply | email address for the reply | {center}\-{center} | {center}No{center} |
| subject | the subject of the mail | {center}petals-bc-mail{center} | {center}No{center} |
| send-mode | Send either the source, the attachments or both of the payload | {center}content-and-attachments{center} | {center}No{center} |
{table-plus}
{include:0 CDK SU Interceptor configuration}
h4. 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
{noformat}
su-mail.zip
+ META-INF
- jbi.xml
- service.xml
{noformat}
h1. Invoking service on incoming email
{center}
!Petals-BC-Mail 3.2.x^schema_provide.png|border=0,width=500,height=259!
*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
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}
\\
{center}{*}Configuration of a Service Unit to consume a service (Mail)*{center}
{table-plus}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (imap or pop3) | {center}\-{center} | {center}Yes{center} |
| username | the username used for authentication | {center}\-{center} | {center}No{center} |
| password | the password used for authentication. Can be null or empty | {center}\-{center} | {center}No{center} |
| host | the host used for connection | {center}\-{center} | {center}Yes{center} |
| port | the port used for connection | {center}* imap : 143
* pop3 : 110{center} | {center}No{center} |
| folder | the folder to check for new mails | {center}INBOX{center} | {center}No{center} |
| period | the checking period time | {center}60 000 ms{center} | {center}No{center} |
| expunge | Expunge deleted messages (read messages are marked as DELETED, default is TRUE) | {center}true{center} | {center}No{center} |
{table-plus}
{include:0 CDK SU Interceptor configuration}
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}
h1. Component Configuration
{include:0 CDK Component Configuration Table 2.1}
{include:0 CDK Parameter scope}
\\
{center}{*}Configuration of the component (Mail)*{center}
{table-plus}
|| Parameter || Description || Default || Required ||
| host | Define the smtp server address | {center}\-{center} | {center}Yes{center} |
| port | Define the smtp server port | {center}25{center} | {center}Yes{center} |
| user | Define the username used for authentication | {center}\-{center} | {center}no{center} |
| password | Define the password used for authentication | {center}\-{center} | {center}no{center} |
{table-plus}
This specific parameters can be also set through JMX or with Ant task during its installation phase.
Ant task exemple :
{code:lang=xml}
<jbi-install-component file="$\{MyPath\}/petals-bc-mail.zip" port="7700" host="localhost" username="petals" password="petals">
<param name="host" value="devmail" />
<param name="port" value="25" />
<param name="user" value="petals" />
<param name="password" value="petals" />
</jbi-install-component>
{code}
{note}This parameter are useful only for dynamic exposition mode{note}
{include:0 CDK component Interceptor configuration}
{column}
{column:width=350px}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}
{column}
h1. Exposing a SMTP transfer as a service. (Provides mode)
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.
\\
{center} !Petals-BC-Mail 3.2.x^schema_provide.png|border=0,width=500,height=259!
*Sending mails{*}{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. Dynamic Exposition
The component can expose directly a generic SendMail service without deploying a service unit.
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.
Parameters (host, port, user, passwordl) have to be defined at component level (cf section *Component Configuration*), otherwise the component can not 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:
{code:lang=xml}
<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>
{code}
* 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 ||
| \{\[http://www.w3.org/2005/08/addressing\]}To | email address of the recipient | {center}\-{center} | {center}Yes{center} |
| \{\[http://www.w3.org/2005/08/addressing\]}From | email address of the sender | {center}\-{center} | {center}Yes{center} |
| \{\[http://www.w3.org/2005/08/addressing\]}ReplyTo | email address for the reply | {center}\-{center} | {center}no{center} |
| \{\[http://www.w3.org/2005/08/addressing\]}Action | the subject of the mail | {center}petals-bc-mail{center} | {center}no{center} |
h2. Static exposition
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.
h3. 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).
The IN message looks like :
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<mail>[#5]mail by using service unit</mail>
{code}
{warning:title=warning}
InOnly message exchange patterns are allowed.
{warning}
h3. Configuration
h4. 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}
\\
{center}{*}Configuration of a Service Unit to provide a service (Mail)*{center}
{table-plus}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (smtp) | {center}\-{center} | {center}Yes{center} |
| username | the username used for authentication | {center}\-{center} | {center}No{center} |
| password | the password used for authentication. Can be null or empty | {center}\-{center} | {center}No{center} |
| host | the host used for connection | {center}\-{center} | {center}Yes{center} |
| port | the port used for connection | {center}\-{center} | {center}Yes{center} |
| to | email address of the recipient | {center}\-{center} | {center}Yes{center} |
| from | email address of the sender | {center}\-{center} | {center}Yes{center} |
| reply | email address for the reply | {center}\-{center} | {center}No{center} |
| subject | the subject of the mail | {center}petals-bc-mail{center} | {center}No{center} |
| send-mode | Send either the source, the attachments or both of the payload | {center}content-and-attachments{center} | {center}No{center} |
{table-plus}
{include:0 CDK SU Interceptor configuration}
h4. 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
{noformat}
su-mail.zip
+ META-INF
- jbi.xml
- service.xml
{noformat}
h1. Invoking service on incoming email
{center}
!Petals-BC-Mail 3.2.x^schema_provide.png|border=0,width=500,height=259!
*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
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}
\\
{center}{*}Configuration of a Service Unit to consume a service (Mail)*{center}
{table-plus}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (imap or pop3) | {center}\-{center} | {center}Yes{center} |
| username | the username used for authentication | {center}\-{center} | {center}No{center} |
| password | the password used for authentication. Can be null or empty | {center}\-{center} | {center}No{center} |
| host | the host used for connection | {center}\-{center} | {center}Yes{center} |
| port | the port used for connection | {center}* imap : 143
* pop3 : 110{center} | {center}No{center} |
| folder | the folder to check for new mails | {center}INBOX{center} | {center}No{center} |
| period | the checking period time | {center}60 000 ms{center} | {center}No{center} |
| expunge | Expunge deleted messages (read messages are marked as DELETED, default is TRUE) | {center}true{center} | {center}No{center} |
{table-plus}
{include:0 CDK SU Interceptor configuration}
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}
h1. Component Configuration
{include:0 CDK Component Configuration Table 2.1}
{include:0 CDK Parameter scope}
\\
{center}{*}Configuration of the component (Mail)*{center}
{table-plus}
|| Parameter || Description || Default || Required ||
| host | Define the smtp server address | {center}\-{center} | {center}Yes{center} |
| port | Define the smtp server port | {center}25{center} | {center}Yes{center} |
| user | Define the username used for authentication | {center}\-{center} | {center}no{center} |
| password | Define the password used for authentication | {center}\-{center} | {center}no{center} |
{table-plus}
This specific parameters can be also set through JMX or with Ant task during its installation phase.
Ant task exemple :
{code:lang=xml}
<jbi-install-component file="$\{MyPath\}/petals-bc-mail.zip" port="7700" host="localhost" username="petals" password="petals">
<param name="host" value="devmail" />
<param name="port" value="25" />
<param name="user" value="petals" />
<param name="password" value="petals" />
</jbi-install-component>
{code}
{note}This parameter are useful only for dynamic exposition mode{note}
{include:0 CDK component Interceptor configuration}
{column}
{column:width=350px}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}