Page edited by Christian MuellerChanges (1)
Full ContentMail ComponentThe mail component provides access to Email via Spring's Mail support and the underlying JavaMail system. Maven users will need to add the following dependency to their pom.xml for this component: <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-mail</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>
Mail Message ContentCamel uses the message exchange's IN body as the MimeMessage text content. The body is converted to String.class. Camel copies all of the exchange's IN headers to the MimeMessage headers. The subject of the MimeMessage can be configured using a header property on the IN message. The code below demonstrates this: from("direct:a").setHeader("subject", constant(subject)).to("smtp://james2@localhost"); The same applies for other MimeMessage headers such as recipients, so you can use a header property as To: Map<String, Object> map = new HashMap<String, Object>(); map.put("To", "davscl...@apache.org"); map.put("From", "jstrac...@apache.org"); map.put("Subject", "Camel rocks"); String body = "Hello Claus.\nYes it does.\n\nRegards James."; template.sendBodyAndHeaders("smtp://davscl...@apache.org", body, map); Headers take precedence over pre-configured recipientsFrom Camel 1.5 onwards, the recipients specified in the message headers always take precedence over recipients pre-configured in the endpoint URI. The idea is that if you provide any recipients in the message headers, that is what you get. The recipients pre-configured in the endpoint URI are treated as a fallback. In the sample code below, the email message is sent to davscl...@apache.org, because it takes precedence over the pre-configured recipient, i...@mycompany.com. Any CC and BCC settings in the endpoint URI are also ignored and those recipients will not receive any mail. The choice between headers and pre-configured settings is all or nothing: the mail component either takes the recipients exclusively from the headers or exclusively from the pre-configured settings. It is not possible to mix and match headers and pre-configured settings.
Map<String, Object> headers = new HashMap<String, Object>();
headers.put("to", "davscl...@apache.org");
template.sendBodyAndHeaders("smtp://admin@localhost?to=i...@mycompany.com", "Hello World", headers);
Multiple recipients for easier configurationAs of Camel 1.5, it is possible to set multiple recipients using a comma-separated or a semicolon-separated list. This applies both to header settings and to settings in an endpoint URI. For example:
Map<String, Object> headers = new HashMap<String, Object>();
headers.put("to", "davscl...@apache.org ; jstrac...@apache.org ; ningji...@apache.org");
The preceding example uses a semicolon, ;, as the separator character. Setting sender name and emailYou can specify recipients in the format, name <email>, to include both the name and the email address of the recipient. For example, you define the following headers on the a Message: Map headers = new HashMap(); map.put("To", "Claus Ibsen <davscl...@apache.org>"); map.put("From", "James Strachan <jstrac...@apache.org>"); map.put("Subject", "Camel is cool"); SUN JavaMailSUN JavaMail is used under the hood for consuming and producing mails.
SamplesWe start with a simple route that sends the messages received from a JMS queue as emails. The email account is the admin account on mymailserver.com.
from("jms://queue:subscription").to("smtp://ad...@mymailserver.com?password=secret");
In the next sample, we poll a mailbox for new emails once every minute. Notice that we use the special consumer option for setting the poll interval, consumer.delay, as 60000 milliseconds = 60 seconds.
from("imap://ad...@mymailserver.com
password=secret&unseen=true&consumer.delay=60000")
.to("seda://mails");
In this sample we want to send a mail to multiple recipients. This feature was introduced in camel 1.4: // all the recipients of this mail are: // To: ca...@riders.org , e...@riders.org // CC: m...@you.org // BCC: some...@somewhere.org String recipients = "&To=ca...@riders.org,e...@riders.org&CC=m...@you.org&BCC=some...@somewhere.org"; from("direct:a").to("smtp://y...@mymailserver.com?password=secret&From=y...@apache.org" + recipients); Sending mail with attachment sample
The mail component supports attachments, which is a feature that was introduced in Camel 1.4. In the sample below, we send a mail message containing a plain text message with a logo file attachment. // create an exchange with a normal body and attachment to be produced as email Endpoint endpoint = context.getEndpoint("smtp://ja...@mymailserver.com?password=secret"); // create the exchange with the mail message that is multipart with a file and a Hello World text/plain message. Exchange exchange = endpoint.createExchange(); Message in = exchange.getIn(); in.setBody("Hello World"); in.addAttachment("logo.jpeg", new DataHandler(new FileDataSource("src/test/data/logo.jpeg"))); // create a producer that can produce the exchange (= send the mail) Producer producer = endpoint.createProducer(); // start the producer producer.start(); // and let it go (processes the exchange by sending the email) producer.process(exchange); SSL sampleIn this sample, we want to poll our Google mail inbox for mails. To download mail onto a local mail client, Google mail requires you to enable and configure SSL. This is done by logging into your Google mail account and changing your settings to allow IMAP access. Google have extensive documentation on how to do this. from("imaps://imap.gmail.com?username=your_usern...@gmail.com&password=YOUR_PASSWORD" + "&delete=false&unseen=true&consumer.delay=60000").to("log:newmail"); The preceding route polls the Google mail inbox for new mails once every minute and logs the received messages to the newmail logger category. 2008-05-08 06:32:09,640 DEBUG MailConsumer - Connecting to MailStore imaps//imap.gmail.com:993 (SSL enabled), folder=INBOX 2008-05-08 06:32:11,203 DEBUG MailConsumer - Polling mailfolder: imaps//imap.gmail.com:993 (SSL enabled), folder=INBOX 2008-05-08 06:32:11,640 DEBUG MailConsumer - Fetching 1 messages. Total 1 messages. 2008-05-08 06:32:12,171 DEBUG MailConsumer - Processing message: messageNumber=[332], from=[James Bond <0...@mi5.co.uk>], to=your_usern...@gmail.com], subject=[... 2008-05-08 06:32:12,187 INFO newmail - Exchange[MailMessage: messageNumber=[332], from=[James Bond <0...@mi5.co.uk>], to=your_usern...@gmail.com], subject=[... Consuming mails with attachment sampleIn this sample we poll a mailbox and store all attachments from the mails as files. First, we define a route to poll the mailbox. As this sample is based on google mail, it uses the same route as shown in the SSL sample: from("imaps://imap.gmail.com?username=your_usern...@gmail.com&password=YOUR_PASSWORD" + "&delete=false&unseen=true&consumer.delay=60000").process(new MyMailProcessor()); Instead of logging the mail we use a processor where we can process the mail from java code:
public void process(Exchange exchange) throws Exception {
// the API is a bit clunky so we need to loop
Map<String, DataHandler> attachments = exchange.getIn().getAttachments();
if (attachments.size() > 0) {
for (String name : attachments.keySet()) {
DataHandler dh = attachments.get(name);
// get the file name
String filename = dh.getName();
// get the content and convert it to byte[]
byte[] data = ""
.convertTo(byte[].class, dh.getInputStream());
// write the data to a file
FileOutputStream out = new FileOutputStream(filename);
out.write(data);
out.flush();
out.close();
}
}
}
As you can see the API to handle attachments is a bit clunky but it's there so you can get the javax.activation.DataHandler so you can handle the attachments using standard API. See Also
Change Notification Preferences
View Online
|
View Changes
|
Add Comment
|
- [CONF] Apache Camel > Mail confluence
- [CONF] Apache Camel > Mail confluence
- [CONF] Apache Camel > Mail confluence
- [CONF] Apache Camel > Mail confluence
- [CONF] Apache Camel > Mail confluence
- [CONF] Apache Camel > Mail confluence
