Mail Egress Connector

The Mail Egress Connector can be used to send emails using UltraESB-X via a mail server.

For using the Mail Egress Connector, you must first select the Mail Connector dependency from the connectors list when creating an empty Ultra project. If you have already created a project, you can add the Mail Connector dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Connectors list, select the Mail Connector dependency.

A minimal configuration for the Mail Egress Connector consists of the following:

In addition, at least one of the To, CC or BCC fields may need to be specified as the email recipient. If none is specified, the destination address of the message will be used as the To address of the outbound email. Some mail server implementations may also require a suitable From address for the outbound email.

If the mail service is accessible only over SSL (as is the case with mail providers like Gmail or Yahoo), an Other Settings Map containing mail.<protocol>.starttls.enable set to true will also have to be specified. The Other Settings Map can also be useful for specifying other custom transport-related parameters, such as standard JavaMail parameters.

In order to trigger the mail sending flow, let’s start with a Timer Task Listener as the ingress connector for the flow (which will generate only a single "tick", Polling Repeat Count having been set to 0, hence sending out only one test email):

Since the inbound message from the Timer Task Listener has no payload, let’s add a String Payload Setter to populate the message with a test payload string (which will be made available as the body of the email):

If the payload is of text/html content type, a multipart email would be generated appropriately, but otherwise a plaintext email would be generated with the raw message payload as the email body.

If attachments are available in the UltraESB-X message received by the Mail Egress Connector, they would be attached to the outbound email. Add a File Attacher element to attach a file from a known location to the message:

Also, create a file /tmp/test.txt with some sample text, to be picked by the File Attacher.

Finally, let’s add a Mail Egress Connector for sending out the enriched message as an email, with the following configurations:

(Replace the email account user, password and the From, Reply-To and destination email addresses as per your choice.)

To define the mail-sender-props Map resource, use the Map button on the project.xpml editor:

The final flow would resemble the following:

For this exercise, in order to see the actual email sending in action, let’s increase the log level of the mail transport by updating src/test/resources/log4j2.xml:

log4j2.xml (src/test/resources/)

Now, after creating a run configuration and running the project, you will be able to see an email being composed and sent via the configured email account:

Now check the email accounts under the To and BCC fields, to verify that the email has been sent out correctly. The email will contain the Test Subject subject, with a plaintext email body test payload and a test.txt attachment containing the text from /tmp/test.txt. If you attempt to reply to the email, the recipient of the composed email would be the address included in the Reply-To field, rather than the original sender (From address).

* marked fields are mandatory.