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
  6. SMTP plays a crucial role in email infrastructure by managing outgoing messages. It connects mail servers, processes delivery requests, and ensures that emails are correctly formatted and delivered without data loss.

    ReplyDelete

Post a Comment

Popular posts from this blog

How to protect your APIs with self contained access token (JWT) using WSO2 API Manager and WSO2 Identity Server

In a typical enterprise information system, there is a high chance that people will use different types of systems built by different vendors to implement certain types of functionalities. The APIs might be hosted in an API Manager developed by vendor A and the user management can be implemented using a different vendor (vendor B). In this type of a situation, one system will not be able to directly contact the other system but they want to use both systems in tandem. Self-contained access tokens are used in these types of situations where applications can get the token from one system and use that in another system to access protected resources. In this scenario, the second system does not need to make a contact to the first system over the network to validate the user information since the token is self-contained and it has relevant details about the user. This will improve the token processing time significantly since it completely removes the network interaction. The below fig...

WSO2 ESB creating a response for a "GET" request

When you are creating REST APIs with WSO2 ESB, you may need to send some response message back to the user when something goes wrong. In this kind of scenario, you can create a payload inside the ESB and send it back. For doing this, you can use the below configuration. <api xmlns=" http://ws.apache.org/ ns/synapse " name="LoopBackProxy" context="/loopback">    <resource methods="POST GET">       <inSequence>          <property name="NO_ENTITY_BODY" scope="axis2" action="remove"></property>          <log level="full"></log>          <payloadFactory media-type="xml">             <format>                <m:messageBeforeLoopBack xmlns:m=" http://services...

WSO2 ESB usage of get-property function

What are Properties? WSO2 has a huge set of mediators but property mediator is mostly used mediator for writing any proxy service or API. Property mediator is used to store any value or xml fragment temporarily during life cycle of a thread for any service or API. We can compare “Property” mediator with “Variable” in any other traditional programming languages (Like: C, C++, Java, .Net etc). There are few properties those are used/maintained by ESB itself and on the other hand few properties can be defined by users (programmers). In other words, we can say that properties can be define in below 2 categories: ESB Defined Properties User Defined Properties. These properties can be stored/defined in different scopes, like: Transport Synapse or Default Axis2 Registry System Operation Generally, these properties are read by get-properties() function. This function can be invoked with below 2 variations. get-property(String propertyName) get-property(String scop...