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

Understanding Threads created in WSO2 ESB

WSO2 ESB is an asynchronous high performing messaging engine which uses Java NIO technology for its internal implementations. You can find more information about the implementation details about the WSO2 ESB’s high performing http transport known as Pass-Through Transport (PTT) from the links given below. [1] http://soatutorials.blogspot.com/2015/05/understanding-wso2-esb-pass-through.html [2] http://wso2.com/library/articles/2013/12/demystifying-wso2-esb-pass-through-transport-part-i/ From this tutorial, I am going to discuss about various threads created when you start the ESB and start processing requests with that. This would help you to troubleshoot critical ESB server issues with the usage of a thread dump. You can monitor the threads created by using a monitoring tool like Jconsole or java mission control (java 1.7.40 upwards). Given below is a list of important threads and their stack traces from an active ESB server.  PassThroughHTTPSSender ( 1 Thread )

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

How to configure timeouts in WSO2 ESB to get rid of client timeout errors

WSO2 ESB has defined some configuration parameters which controls the timeout of a particular request which is going out of ESB. In a particular  scneario, your client sends a request to ESB, and then ESB sends a request to another endpoint to serve the request. CLIENT->WSO2 ESB->BACKEND The reason for clients getting timeout is that ESB timeout is larger than client's timeout. This can be solved by either increasing the timeout at client side or by decreasing the timeout in ESB side. In any of the case, you can control the timeout in ESB using the below properties. 1) Global timeout defined in synapse.properties (ESB_HOME\repository\conf\) file. This will decide the maximum time that a callback is waiting in the ESB for a response for a particular request. If ESB does not get any response from Back End, it will drop the message and clears out the call back. This is a global level parameter which affects all the endpoints configured in ESB. synapse.global_timeout_inte