{section}
{column}

{warning}This version must be installed on [Petals ESB 5.2.0|petalsesb520:Petals ESB 5.2.0]+{warning}

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}
!schema_provide.png|width=600,,height=311!

*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...).
{column}
{column:width=350px}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}

h2. Native service

The component can expose directly a generic service without deploying a service unit to send mails.

To allow the component to provide this generic service, the component must have the WSDL named '{{component.wsdl}}'. To deactivate the generic service supplied by the component, simply remove the file '{{component.wsdl}}' from the component archive.

This service offer two modes:
* *In-payload mode*: The service allows the consumer to send a specific XML message to the component with-all the information needed in the payload to send an email.

The IN message looks like :
{code:lang=xml}
<ns0:mail
xmlns:ns0="http://petals.ow2.org/components/mail/generic/version-3"
xmlns:ns1="http://petals.ow2.org/components/mail/version-3">
      <ns1:host>localhost</ns1:host>
      <ns1:port>25</ns1:port>
      <ns1:user>user</ns1:user>
      <ns1:password>pwd</ns1:password>
<ns1:starttls>true</ns1:starttls>
      <ns1:scheme>smtp</ns1:scheme>
      <ns1:from>from@from.com</ns1:from>
      <ns1:reply>reply@reply.com</ns1:reply>
      <ns1:to>to@to.com</ns1:to>
<ns1:cc>cc@cc.com</ns1:cc>
<ns1:bcc>bcc@bcc.com</ns1:bcc>
      <ns1:subject>subject</ns1:subject>
      <ns1:helohost>helo</ns1:helohost>
      <ns1:send-mode>content-and-attachments</ns1:send-mode>
      <ns1:content-type>text/plain</ns1:content-type>
      <ns1:body>My email content</ns1:body>
</ns0:mail>
{code}

* *WS-Addressing mode*: The service allows the consumer to send a JBI message to the component by setting WS-Addressing properties in the IN message with all the information needed to send an email. The content of the mail (body) is in the payload of the message.

The IN message looks like:
{code:lang=xml}
<ns0:mail
xmlns:ns0="http://petals.ow2.org/components/mail/generic/version-3"
xmlns:ns1="http://petals.ow2.org/components/mail/version-3">
<ns1:body>My Mail Content</ns1:body>
</ns0:mail>
{code}

The possible properties are the following:
{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| IN Property || Description || Default || Required ||
| \{[http://www.w3.org/2005/08/addressing]}To | email addresses of the recipients 'To' | \- | Yes |
| \{[http://www.w3.org/2005/08/addressing]}Cc | email addresses of the recipients 'Cc' | \- | No |
| \{[http://www.w3.org/2005/08/addressing]}Bcc | email addresses of the recipients 'Bcc' | \- | No |
| \{[http://www.w3.org/2005/08/addressing]}From | email address of the sender | \- | Yes |
| \{[http://www.w3.org/2005/08/addressing]}ReplyTo | email address for the reply | \- | no |
| \{[http://www.w3.org/2005/08/addressing]}Action | the subject of the mail | petals-bc-mail | no |
| \{[http://petals.ow2.org/components/mail/version-3]}Host | the host used for connection | \- | Yes |
| \{[http://petals.ow2.org/components/mail/version-3]}Port | the port used for connection | 25 | No |
| \{[http://petals.ow2.org/components/mail/version-3]}User | the username used for authentication | \- | No |

| \{[http://petals.ow2.org/components/mail/version-3]}ContentType | The mail mime type | text/plain | no |
{table-plus}

h2. Integration service

Petals BC Mail can be configured to provide an *integration service provider* deploying a service unit. A part of the service contract of this integration service provider is commanded by Petals BC Mail:
* abstract part (port-type and messages) of the WSDL is completely commanded by Petals BC Mail,
* you can choose your own names for the concrete part (binding and service).

Once the service unit is deployed, you just have to send message exchange with an IN message as following to send an email:
{code:lang=xml}
<ns0:mail
xmlns:ns0="http://petals.ow2.org/components/mail/version-3/intg-itf"
xmlns:ns1="http://petals.ow2.org/components/mail/version-3">
<ns1:body>My Mail Content</ns1:body>
</ns0:mail>
{code}

h3. Usage

{warning:title=warning} InOnly message exchange patterns are allowed.{warning}

If the email content is a markup language, it's recommended to use CDATA section or to escape illegal XML character:

Example of IN message with CDATA section:
{code:lang=xml}
<ns0:mail
xmlns:ns0="http://petals.ow2.org/components/mail/version-3/intg-itf"
xmlns:ns1="http://petals.ow2.org/components/mail/version-3">
<ns1:body><![CDATA[<element>my content</element>]]></ns1:body>
</ns0:mail>
{code}

Example of IN message with escaped illegal XML character:
{code:lang=xml}
<ns0:mail
xmlns:ns0="http://petals.ow2.org/components/mail/version-3/intg-itf"
xmlns:ns1="http://petals.ow2.org/components/mail/version-3">
<ns1:body>&lt;element&gt;my content&lt;/element&gt;</ns1:body>
</ns0:mail>
{code}

h3. Configuration

h4. Service Unit descriptor

{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<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"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
xmlns:generatedNs="http://test">

<jbi:services binding-component="true">
<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:starttls>true</mail:starttls>
<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>
<mail:send-mode>content-and-attachments</mail:send-mode>
<mail:content-type>text/plain</mail:content-type>
</jbi:provides>
</jbi:services>
</jbi:jbi>
{code}

{include:0 CDK SU Provide Configuration 5.7.0}

{center}{*}Configuration of a Service Unit to provide a service (Mail)*{center}
{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (smtp) | \- | 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 | 25 | No |
| starttls | enable STARTTLS | false | No |
| to | email addresses of the recipients 'To' | \- | Yes |
| cc | email addresses of the recipients 'Cc' | \- | No |
| bcc | email addresses of the recipients 'Bcc' | \- | No |
| from | email address of the sender | \- | Yes |
| reply | email address for the reply | \- | No |
| subject | the subject of the mail | petals-bc-mail | No |
| helohost | HELO host for SMTP | \- | No |
| send-mode | Send either the source, the attachments or both of the payload | content-and-attachments | No |
| content-type | The mail mime type | text/plain | no |
{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.wsdl
{noformat}

h2. Pivot service

Petals BC Mail can be configured to provide an *pivot service provider* deploying a service unit. With *pivot service provider* you are able to define it your own WSDL to better match your needs.

Using a pivot service is better than native or integration service because you will be more agile, you will be able to change the implementation of your pivot service (replacing Petals BC Mail) with impacts on your service consumers. It is not possible with native and integration services.

h3. Usage

{warning:title=warning} InOnly message exchange patterns are allowed.{warning}

The mail sent depends on:
* annotations that you have put in your WSDL. Annotations provides a way to get values of parameters to send mail from your incoming payload.
* and parameters available at SU descriptor level.

h3. Configuration

h4. WSDL annotations

Several WSDL annotations are available. They should be put in the binding section of your WSDL:
{code:lang=xml}
<wsdl:binding name="emailNotifyVacationBinding" type="notifyService:emailNotifyVacation"
xmlns:bcmail="http://petals.ow2.org/bc/mail/annotations/1.0" >
...
<wsdl:operation name="newVacationRequest">
<bcmail:subject>Your new vacation request #${/*[local-name()='newVacationRequest']/*[local-name()='vacationRequestId']} was submitted for validation</bcmail:subject>
<bcmail:body><![CDATA[
<p>
You have submitted a new vacation request for validation:
<ul>
<li>reference: #${/*[local-name()='newVacationRequest']/*[local-name()='vacationRequestId']},</li>
<li>first day: ${/*[local-name()='newVacationRequest']/*[local-name()='start-date']},</li>
<li>duration: ${/*[local-name()='newVacationRequest']/*[local-name()='day-number']} day(s),</li>
<li>reason: ${/*[local-name()='newVacationRequest']/*[local-name()='reason']}</li>
</ul>
</p>]]>
</bcmail:body>
<bcmail:to>//*[local-name()='newVacationRequest']/*[local-name()='recipient']/text()</bcmail:to>
<bcmail:header>
<bcmail:name>X-VacationRequestId</bcmail:name>
<bcmail:value>${/*[local-name()='newVacationRequest']/*[local-name()='vacationRequestId']}</bcmail:value>
</bcmail:header>
<bcmail:header>
<bcmail:name>X-VacationRequestStartDate</bcmail:name>
<bcmail:value>${substring-before(/*[local-name()='newVacationRequest']/*[local-name()='start-date'], 'T')}</bcmail:value>
</bcmail:header>
<bcmail:header>
<bcmail:name>X-VacationRequestDayNumber</bcmail:name>
<bcmail:value>${/*[local-name()='newVacationRequest']/*[local-name()='day-number']}</bcmail:value>
</bcmail:header>
<wsdl:input>...</wsdl:input>
</wsdl:operation>
</wsdl:binding>
{code}

All annotations are member of namespace '{{http://petals.ow2.org/bc/mail/annotations/1.0}}'. Annotations override content of the SU descriptor. Available annotations are:
|| Name || Description || Required || Default value ||
| subject | Mail subject. To be able to put data extracted from the incoming message, you can use XPath expression placeholders as '$\{<xpath-expression>}' in the content of this annotation. | No | - |
| body | Mail body. To be able to put data extracted from the incoming message, you can use XPath expression placeholders as '$\{<xpath-expression>}' in the content of this annotation. | No | - |
| to | Email addresses of recipients 'To' of the mail, defined as a XPath expression returning a list of XML nodes. The content value of each node must be one email address. | Yes | - |
| cc | Email addresses of recipients 'Cc' of the mail, defined as a XPath expression returning a list of XML nodes. The content value of each node must be one email address. | No | - |
| bcc | Email addresses of recipients 'Bcc' of the mail, defined as a XPath expression returning a list of XML nodes. The content value of each node must be one email address. | No | - |
| options | Use to set options on mail. Options are available as attributes:
* {{dsn-on-delay}}: Enable Delivery Status Notification (DSN) on delay,
* {{dsn-on-failure}}: Enable DSN on mail sent with failure,
* {{dsn-on-success}}: Enable DSN on mail sent succesfully,
* {{dsn-on-never}}: Disable DSN,
* {{dsn-content}}: Define the content of DSN: {{full}} (entire body) or {{headers}} (only headers). | No | - |
| header | Use to add headers in your mail. The header name is defined through the sub-tag '{{name}}', and its value through '{{value}}'. The value can contains XPath expression placeholders as '$\{<xpath-expression>}'. | No | - |

h4. Service Unit descriptor

{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<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"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-4.0"
xmlns:generatedNs="http://test">

<jbi:services binding-component="true">
<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:starttls>true</mail:starttls>
<mail:from>from email address</mail:from>
<mail:reply>reply email address</mail:reply>
<mail:to>recipient 'To' addresses</mail:to>
<mail:cc>recipient 'Cc' addresses</mail:cc>
<mail:bcc>recipient 'Bcc' addresses</mail:bcc>
<mail:subject>mail subject</mail:subject>
<mail:send-mode>content-and-attachments</mail:send-mode>
<mail:content-type>text/plain</mail:content-type>
</jbi:provides>
</jbi:services>
</jbi:jbi>
{code}

{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| Parameter || Description || Default || Required ||
| scheme | the connection protocol (smtp) | \- | 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 | 25 | No |
| starttls | enable STARTTLS | false | No |
| to | email address of the recipient | \- | Yes |
| from | email address of the sender | \- | Yes |
| reply | email address for the reply | \- | No |
| subject | the subject of the mail | petals-bc-mail | No |
| helohost | HELO host for SMTP | \- | No |
| send-mode | Send either the source, the attachments or both of the payload | content-and-attachments | No |
| content-type | The mail mime type | text/plain | no |
{table-plus}

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,
* You own WSDL file describing the related service

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

h1. Invoking service on incoming email

{center}

!schema_consume.png|width=600,height=310!


*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 periodically checks for new mails and imports them.
* Step 3and 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:starttls>true</mail:starttls>
<mail:enable-ssl>true</mail:enable-ssl>
<mail:folder>INBOX</mail:folder>
<mail:delete>true</mail:delete>
<mail:period>60000</mail:period>
<mail:isxmlcontent>false</mail:isxmlcontent>
</jbi:consumes>
</jbi:services>
</jbi:jbi>
{code}
{include:0 CDK SU Consume Configuration 5.7.0}

\\
{center}{*}Configuration of a Service Unit to consume a service (Mail)*{center}
{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| 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 |
| starttls | enable STARTTLS | false | No |
| enable-ssl | enable support of SSL | false | No |
| folder | the folder to check for new mails | INBOX | No |
| delete | Expunge deleted messages (read messages are marked as DELETED, default is TRUE) | true | No |
| period | the checking period time | 60 000 ms | No |
| isxmlcontent | Assume mail content is XML. If false, mail content will be wrapped in an <body /> element. | false | No |
{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 5.6.0}
{include:0 CDK Parameter scope}
{include:0 CDK component Interceptor configuration}

h1. Monitoring the component

h2. Using metrics

Several probes providing metrics are included in the component, and are available through the JMX MBean '{{org.ow2.petals:type=custom,name=monitoring_*<component-id>*}}', where {{*<component-id>*}} is the unique JBI identifier of the component.

h3. Common metrics

{include:0 CDK Component Monitoring Metrics 5.6.0}

h3. Dedicated metrics

No dedicated metric is available.

h2. Receiving alerts

Several alerts are notified by the component through notification of the JMX MBean '{{org.ow2.petals:type=custom,name=monitoring_*<component-id>*}}', where {{*<component-id>*}} is the unique JBI identifier of the component.

{tip}To integrate these alerts with Nagios, see [petalsesbsnapshot:Receiving Petals ESB defects in Nagios].{tip}

h3. Common alerts

{include:0 CDK Component Monitoring Alerts 5.6.0}

h3. Dedicated alerts

No dedicated alert is available.