{"id":449,"date":"2011-06-06T18:48:00","date_gmt":"2011-06-06T18:48:00","guid":{"rendered":"http:\/\/www.javacodegeeks.com\/2012\/10\/spring-quartz-and-javamail-integration-tutorial.html"},"modified":"2012-10-21T19:51:09","modified_gmt":"2012-10-21T19:51:09","slug":"spring-quartz-javamail-tutorial","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2011\/06\/spring-quartz-javamail-tutorial.html","title":{"rendered":"Spring, Quartz and JavaMail Integration Tutorial"},"content":{"rendered":"
Quartz is a job scheduling framework which is used to schedule the jobs to be executed on the specified time schedule.JavaMail is an API to send\/recieve emails from Java Applications.<\/p>\n

Spring has integration points to integrate Quartz and JavaMail which makes easy to use those APIs. Lets create a small demo application to show how to integrate Spring + Quartz + JavaMail.<\/p>\n

Our application is to send birthday wishes emails to friends everyday at 6 AM.<\/p>\n

Email.java<\/strong><\/p>\n

package com.sivalabs.reminders;\r\n \r\nimport java.util.ArrayList;\r\nimport java.util.List;\r\n \r\npublic class Email\r\n{\r\n private String from;\r\n private String[] to;\r\n private String[] cc;\r\n private String[] bcc;\r\n private String subject;\r\n private String text;\r\n private String mimeType;\r\n private List<Attachment> attachments = new ArrayList<Attachment>();\r\n  \r\n public String getFrom()\r\n {\r\n  return from;\r\n }\r\n public void setFrom(String from)\r\n {\r\n  this.from = from;\r\n }\r\n public String[] getTo()\r\n {\r\n  return to;\r\n }\r\n public void setTo(String... to)\r\n {\r\n  this.to = to;\r\n }\r\n public String[] getCc()\r\n {\r\n  return cc;\r\n }\r\n public void setCc(String... cc)\r\n {\r\n  this.cc = cc;\r\n }\r\n public String[] getBcc()\r\n {\r\n  return bcc;\r\n }\r\n public void setBcc(String... bcc)\r\n {\r\n  this.bcc = bcc;\r\n }\r\n public String getSubject()\r\n {\r\n  return subject;\r\n }\r\n public void setSubject(String subject)\r\n {\r\n  this.subject = subject;\r\n }\r\n public String getText()\r\n {\r\n  return text;\r\n }\r\n public void setText(String text)\r\n {\r\n  this.text = text;\r\n }\r\n public String getMimeType()\r\n {\r\n  return mimeType;\r\n }\r\n public void setMimeType(String mimeType)\r\n {\r\n  this.mimeType = mimeType;\r\n }\r\n public List<Attachment> getAttachments()\r\n {\r\n  return attachments;\r\n }\r\n public void addAttachments(List<Attachment> attachments)\r\n {\r\n  this.attachments.addAll(attachments);\r\n }\r\n public void addAttachment(Attachment attachment)\r\n {\r\n  this.attachments.add(attachment);\r\n }\r\n public void removeAttachment(int index)\r\n {\r\n  this.attachments.remove(index);\r\n }\r\n public void removeAllAttachments()\r\n {\r\n  this.attachments.clear();\r\n }\r\n}\r\n<\/pre>\n
Attachment.java<\/strong><\/p>\n
package com.sivalabs.reminders;\r\n \r\npublic class Attachment\r\n{\r\n private byte[] data;\r\n private String filename;\r\n private String mimeType;\r\n private boolean inline;\r\n  \r\n public Attachment()\r\n {\r\n }\r\n  \r\n public Attachment(byte[] data, String filename, String mimeType)\r\n {\r\n  this.data = data;\r\n  this.filename = filename;\r\n  this.mimeType = mimeType;\r\n }\r\n public Attachment(byte[] data, String filename, String mimeType, boolean inline)\r\n {\r\n  this.data = data;\r\n  this.filename = filename;\r\n  this.mimeType = mimeType;\r\n  this.inline = inline;\r\n }\r\n public byte[] getData()\r\n {\r\n  return data;\r\n }\r\n public void setData(byte[] data)\r\n {\r\n  this.data = data;\r\n }\r\n public String getFilename()\r\n {\r\n  return filename;\r\n }\r\n public void setFilename(String filename)\r\n {\r\n  this.filename = filename;\r\n }\r\n \r\n public String getMimeType()\r\n {\r\n  return mimeType;\r\n }\r\n \r\n public void setMimeType(String mimeType)\r\n {\r\n  this.mimeType = mimeType;\r\n }\r\n \r\n public boolean isInline()\r\n {\r\n  return inline;\r\n }\r\n \r\n public void setInline(boolean inline)\r\n {\r\n  this.inline = inline;\r\n }\r\n  \r\n}\r\n<\/pre>\n
EmailService.java<\/strong>
 
<\/div> <\/div><\/p>\n
package com.sivalabs.reminders;\r\n \r\nimport java.util.List;\r\n \r\nimport javax.activation.DataSource;\r\nimport javax.mail.MessagingException;\r\nimport javax.mail.internet.MimeMessage;\r\nimport javax.mail.util.ByteArrayDataSource;\r\n \r\nimport org.springframework.mail.javamail.JavaMailSenderImpl;\r\nimport org.springframework.mail.javamail.MimeMessageHelper;\r\n \r\npublic class EmailService\r\n{\r\n private JavaMailSenderImpl mailSender = null;\r\n public void setMailSender(JavaMailSenderImpl mailSender)\r\n {\r\n  this.mailSender = mailSender;\r\n }\r\n  \r\n public void sendEmail(Email email) throws MessagingException {\r\n  MimeMessage mimeMessage = mailSender.createMimeMessage();\r\n  \/\/ use the true flag to indicate you need a multipart message\r\n  boolean hasAttachments = (email.getAttachments()!=null &&\r\n         email.getAttachments().size() > 0 );\r\n  MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, hasAttachments);\r\n  helper.setTo(email.getTo());\r\n  helper.setFrom(email.getFrom());\r\n  helper.setSubject(email.getSubject());\r\n  helper.setText(email.getText(), true);\r\n   \r\n  List<Attachment> attachments = email.getAttachments();\r\n     if(attachments != null && attachments.size() > 0)\r\n     {\r\n      for (Attachment attachment : attachments)\r\n      {\r\n          String filename = attachment.getFilename() ;\r\n          DataSource dataSource = new ByteArrayDataSource(attachment.getData(),\r\n                 attachment.getMimeType());\r\n          if(attachment.isInline())\r\n          {\r\n           helper.addInline(filename, dataSource);\r\n          }else{\r\n           helper.addAttachment(filename, dataSource);\r\n          }\r\n      }\r\n     }\r\n   \r\n  mailSender.send(mimeMessage);\r\n }\r\n}\r\n<\/pre>\n
BirthdayWisherJob.java<\/strong><\/p>\n
package com.sivalabs.reminders;\r\n \r\nimport java.io.InputStream;\r\nimport java.util.ArrayList;\r\nimport java.util.Date;\r\nimport java.util.List;\r\n \r\nimport javax.mail.MessagingException;\r\n \r\nimport org.quartz.JobExecutionContext;\r\nimport org.quartz.JobExecutionException;\r\nimport org.springframework.core.io.ClassPathResource;\r\nimport org.springframework.scheduling.quartz.QuartzJobBean;\r\n \r\npublic class BirthdayWisherJob extends QuartzJobBean\r\n{\r\n  \r\n private EmailService emailService;\r\n public void setEmailService(EmailService emailService)\r\n {\r\n  this.emailService = emailService;\r\n }\r\n  \r\n @Override\r\n protected void executeInternal(JobExecutionContext context) throws JobExecutionException\r\n {\r\n  System.out.println(\"Sending Birthday Wishes... \");\r\n  List<User> usersBornToday = getUsersBornToday();\r\n  for (User user : usersBornToday)\r\n  {\r\n   try\r\n   {\r\n    Email email = new Email();\r\n    email.setFrom(\"admin@sivalabs.com\");\r\n    email.setSubject(\"Happy BirthDay\");\r\n    email.setTo(user.getEmail());\r\n    email.setText(\"<h1>Dear \"+user.getName()+\r\n      \",Many Many Happy Returns of the day :-)<\/h1>\");\r\n      \r\n    byte[] data = null;\r\n    ClassPathResource img = new ClassPathResource(\"HBD.gif\");\r\n    InputStream inputStream = img.getInputStream();\r\n    data = new byte[inputStream.available()];\r\n    while((inputStream.read(data)!=-1));\r\n    \r\n    Attachment attachment = new Attachment(data, \"HappyBirthDay\",\r\n      \"image\/gif\", true);\r\n    email.addAttachment(attachment);\r\n    \r\n    emailService.sendEmail(email);\r\n   }\r\n   catch (MessagingException e)\r\n   {\r\n    e.printStackTrace();\r\n   }\r\n   catch (Exception e)\r\n   {\r\n    e.printStackTrace();\r\n   }\r\n  }\r\n }\r\n  \r\n private List<User> getUsersBornToday()\r\n {\r\n  List<User> users = new ArrayList<User>();\r\n  User user1 = new User(\"Siva Prasad\", \"sivaprasadreddy.k@gmail.com\", new Date());\r\n  users.add(user1);\r\n  User user2 = new User(\"John\", \"abcd@gmail.com\", new Date());\r\n  users.add(user2);\r\n  return users;\r\n }\r\n}\r\n<\/pre>\n
applicationContext.xml<\/strong><\/p>\n
<beans>\r\n \r\n <bean class=\"org.springframework.scheduling.quartz.SchedulerFactoryBean\">\r\n <property name=\"triggers\">\r\n  <list>\r\n   <ref bean=\"birthdayWisherCronTrigger\" \/>\r\n  <\/list>\r\n <\/property>\r\n <\/bean>\r\n <bean id=\"birthdayWisherCronTrigger\" class=\"org.springframework.scheduling.quartz.CronTriggerBean\">\r\n  <property name=\"jobDetail\" ref=\"birthdayWisherJob\" \/>\r\n  <!-- run every morning at 6 AM -->\r\n  <property name=\"cronExpression\" value=\"0\/5 * * * * ?\" \/>\r\n <\/bean>\r\n \r\n <bean name=\"birthdayWisherJob\" class=\"org.springframework.scheduling.quartz.JobDetailBean\">\r\n  <property name=\"jobClass\" value=\"com.sivalabs.reminders.BirthdayWisherJob\" \/>\r\n  <property name=\"jobDataAsMap\">\r\n   <map>\r\n    <entry key=\"emailService\" value-ref=\"emailService\"><\/entry>\r\n   <\/map>\r\n  <\/property>\r\n <\/bean>\r\n  \r\n <bean id=\"emailService\" class=\"com.sivalabs.reminders.EmailService\">\r\n  <property name=\"mailSender\" ref=\"mailSender\"><\/property>\r\n <\/bean>\r\n  \r\n <bean id=\"mailSender\" class=\"org.springframework.mail.javamail.JavaMailSenderImpl\">\r\n  <property name=\"defaultEncoding\" value=\"UTF-8\"\/>\r\n  <property name=\"host\" value=\"smtp.gmail.com\" \/>\r\n  <property name=\"port\" value=\"465\" \/>\r\n  <property name=\"protocol\" value=\"smtps\" \/>\r\n  <property name=\"username\" value=\"admin@gmail.com\"\/>\r\n  <property name=\"password\" value=\"*****\"\/>\r\n  <property name=\"javaMailProperties\">\r\n   <props>\r\n    <prop key=\"mail.smtps.auth\">true<\/prop>\r\n    <prop key=\"mail.smtps.starttls.enable\">true<\/prop>\r\n    <prop key=\"mail.smtps.debug\">true<\/prop>\r\n   <\/props>\r\n  <\/property>\r\n <\/bean>\r\n  \r\n<\/beans>\r\n<\/pre>\n
TestClient.java<\/strong><\/p>\n
package com.sivalabs.reminders;\r\n \r\nimport org.springframework.context.ApplicationContext;\r\nimport org.springframework.context.support.ClassPathXmlApplicationContext;\r\n \r\npublic class TestClient {\r\n  \r\n public static void main(String[] args)\r\n {\r\n  ApplicationContext ctx = \r\n     new ClassPathXmlApplicationContext(\"applicationContext.xml\"); \r\n }\r\n \r\n}\r\n<\/pre>\n
Reference: <\/i><\/strong>Spring + Quartz + JavaMail Integration Tutorial<\/a> from our JCG partner<\/a> Siva at the My Experiments on Technology blog<\/a>.<\/p>\n
Related Articles :<\/i><\/strong><\/div>\n