Skip to main content

Send email with attachment in WSO2 ESB


WSO2 ESB comes with a comprehensive set of transports supported. Mail transport is one of the mostly used transports with the WSO2 ESB. This post will guide you to send an email with an attachment by using the WSO2 ESB.
1. First you need to download the WSO2 ESB from the official WSO2 web site.
Extract the downloaded archive file in to a folder inside your computer. This extracted folder will be referred as ESB_HOME in the next part of the post.
2. Enable the mail transport from the axis2 configuration file which is located in the ESB_HOME\repository\conf\axis2\axis2.xml
Uncomment the lines which are related to mail transport
<transportSender name=”mailto”>
<parameter name=”mail.smtp.host”>smtp.gmail.com</parameter>
<parameter name=”mail.smtp.port”>587</parameter>
<parameter name=”mail.smtp.starttls.enable”>true</parameter>
<parameter name=”mail.smtp.auth”>true</parameter>
<parameter name=”mail.smtp.user”>synapse.demo.0</parameter>
<parameter name=”mail.smtp.password”>mailpassword</parameter>
<parameter name=”mail.smtp.from”>synapse.demo.0@gmail.com</parameter>
</transportSender>
<transportReceiver name=”mailto”>
<!– configure any optional POP3/IMAP properties
check com.sun.mail.pop3 and com.sun.mail.imap package documentation for more details–>
</transportReceiver>
Add the required messageFormatter type if it not included in the config file.
<messageFormatter contentType=”text/plain”/>
3.  Now let’s start the WSO2 ESB by executing the following command
ESB_HOME\bin\wso2server.sh (Linux)
ESB_HOME/bin/wso2server.bat (Windows)
4. Then access the management console of the ESB with the following URL
5. In the Main section, click proxy services and add new proxy service with the type as custom proxy type.
Click the source view button and copy the following configuration to the proxy source view.
<proxy xmlns=”http://ws.apache.org/ns/synapse&#8221; name=”MailProxy” transports=”https,http” statistics=”disable” trace=”disable” startOnLoad=”true”>
<target>
<inSequence>
<payloadFactory>
<format>
<ns:sendMailResponse xmlns:ns=”http://services.samples”>$1</ns:sendMailResponse&gt;
</format>
<args>
<arg value=”Message Sent from the WSO2 ESB”/>
</args>
</payloadFactory>
<property name=”transport.mail.Format” value=”Attachment” scope=”axis2″/>
<property name=”AttachmentFile” value=”attachment.csv” scope=”axis2″/>
<property name=”Subject” value=”File Received” scope=”transport”/>
<property name=”OUT_ONLY” value=”true” scope=”default” type=”STRING”/>
<log level=”full”/>
<send>
<endpoint>
<address uri=”mailto:yourname@gmail.com”/>
</endpoint>
</send>
</inSequence>
</target>
<description></description>
</proxy>
Just edit the email address above to your email address and save the proxy by clicking the save button.
Now you have configured the ESB to send an email.
6. Let’s try the written proxy with soapUI client. Now you can check on you email and confirm that email message is received with an attachment of the message content.

Comments

  1. Hello,
    Thanks for this post very helpful.
    I try to make an proxy service that receive email with attach files and save all files in an folder (vfs). If you can help.
    Thanks again for your post

    ReplyDelete
  2. Thanks for sharing a useful post. To connect with Gmail Customer Service, simply call on our toll free number 1-888-410-9071

    ReplyDelete
  3. Yeah!! SMS Attachment has enabled business organizations to share files, brochures, and menus through SMS just the way they did it with an email. Contact us: +91-8349217770 or Sales@Msgclub.Net / Sales@smsprovider.com

    ReplyDelete
  4. This comment has been removed by the author.

    ReplyDelete
  5. I tried the same example.

    I am trying to send the pdf file instead of .csv file. I am receiving the mail. But the PDF document looks corrupted when I downloaded the pdf from mail. Any idea to this issue.

    ReplyDelete

Post a Comment

Popular posts from this blog

How to setup an WSO2 API manager distributed setup with a clustered gateway with WSO2 ELB

In this blog post I am going to describe about how to configure a WSO2 API Manager in a distributed setup with a clustered gateway with WSO2 ELB and the WSO2 G-REG for a distributed deployment in your production environment. Before continuing with this post, you need to download the above mentioned products from the WSO2 website. WSO2 APIM - http://wso2.com/products/api-manager/ WSO2 ELB - http://wso2.com/products/elastic-load-balancer/ Understanding the API Manager architecture API Manager uses the following four main components: Publisher Creates and publishes APIs Store Provides a user interface to search, select, and subscribe to APIs Key Manager Used for authentication, security, and key-related operations Gateway Responsible for securing, protecting, managing, and scaling API calls Here is the deployment diagram that we are going to configure. In this setup, you have 5 APIM nodes with 2 gateway...

WSO2 ESB tuning performance with threads

I have written several blog posts explaining the internal behavior of the ESB and the threads created inside ESB. With this post, I am talking about the effect of threads in the WSO2 ESB and how to tune up threads for optimal performance. You can refer [1] and [2] to understand the threads created within the ESB. [1] http://soatutorials.blogspot.com/2015/05/understanding-threads-created-in-wso2.html [2] http://wso2.com/library/articles/2012/03/importance-performance-wso2-esb-handles-nonobvious/ Within this blog post, I am discussing about the "worker threads" which are used for processing the data within the WSO2 ESB. There are 2 types of worker threads created when you start sending the requests to the server 1) Server Worker/Client Worker Threads 2) Mediator Worker (Synapse-Worker) Threads Server Worker/Client Worker Threads These set of threads will be used to process all the requests/responses coming to the ESB server. ServerWorker Threads will be used to pr...

Performance Tuning WSO2 ESB with a practical example

WSO2 ESB is arguably the highest performing open source ESB available in the industry. With the default settings, it will provide a really good performance OOTB. You can find the official performance tuning guide in the below link. https://docs.wso2.com/display/ESB481/Performance+Tuning Above document includes lot of parameters and how to change them for best performance. Even though it provides some recommended values for the performance tuning, that is not straightforward. The values you put in the configuration files will highly reliant on your use case. Idea of this blog post is to provide a practical example of tuning these parameters with a sample use case. For the performance testing, I am using a simple proxy service which iterate through set of xml elements and send request to a sample server and aggregate the responses back to the client. <?xml version="1.0" encoding="UTF-8"?> <proxy xmlns="http://ws.apache.org/ns/synapse"     ...