decodes.tsdb.alarm.mail.AlarmMailer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendcs Show documentation
A collection of software for aggregatting and processing environmental data such as from NOAA GOES satellites.
The newest version!
/*
 * $Id$
 * 
 * Copyright 2017 Cove Software, LLC. All rights reserved.
 * 
 * $Log$
 * Revision 1.1  2019/03/05 14:53:01  mmaloney
 * Checked in partial implementation of Alarm classes.
 *
 * Revision 1.4  2017/10/03 19:10:35  mmaloney
 * bug fix
 *
 * Revision 1.3  2017/10/03 12:27:43  mmaloney
 * Allow unauthenticated connections to SMTP
 *
 * Revision 1.2  2017/05/17 20:37:12  mmaloney
 * First working version.
 *
 */
package decodes.tsdb.alarm.mail;

import ilex.util.Logger;
import ilex.util.PropertiesUtil;

import java.util.ArrayList;
import java.util.Properties;

import javax.mail.Message;
import javax.mail.PasswordAuthentication;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;

import decodes.tsdb.alarm.AlarmGroup;
import decodes.tsdb.alarm.EmailAddr;

public class AlarmMailer
{
	protected static String module = "AlarmMailer";
	protected Session session = null;
	protected String fromAddr = null;
	protected String fromName = null;
	protected Properties mailProps = null;
	
	/**
	 * The following properties should be supplied:
	 * 
	 *   mail.smtp.auth - true/false
	 *   mail.smtp.starttls.enable - true/false
	 *   mail.smtp.host - hostname or IP addr of mail server
	 *   mail.smtp.port - default=587
	 *   smtp.username
	 *   smtp.password
	 *   fromAddr - email address for the header FROM field
	 *   fromName
	 *   
	 *   
	 * @param props
	 * @throws MailerException
	 */
	public AlarmMailer()
	{
	}
	
	/**
	 * 
	 * @param props
	 * @throws MailerException on an unrecoverable config error.
	 */
	public synchronized void configure(Properties props)
		throws MailerException
	{
		// Set defaults for missing props.
		String s = PropertiesUtil.getIgnoreCase(props, "mail.smtp.auth");
		if (s == null)
			props.put("mail.smtp.auth", "false");
		
		s = PropertiesUtil.getIgnoreCase(props, "mail.smtp.starttls.enable");
		if (s == null)
			props.put("mail.smtp.starttls.enable", "false");
		
		s = PropertiesUtil.getIgnoreCase(props, "mail.smtp.host");
		if (s == null)
			throw new MailerException("Missing required mail.smtp.host property.");
		
		s = PropertiesUtil.getIgnoreCase(props, "mail.smtp.port");
		if (s == null)
			props.put("mail.smtp.port", "587");
		
		
		fromAddr = PropertiesUtil.getIgnoreCase(props, "fromAddr");
		if (fromAddr == null)
			throw new MailerException("Missing required fromAddr property.");

		fromName = PropertiesUtil.getIgnoreCase(props, "fromName");
		if (fromName == null)
			throw new MailerException("Missing required fromName property.");
		
		// Save props and force next call to send() to re-establish the session.
		mailProps = props;
		session = null;
	}
	
	protected void makeSession()
	{
		final String username = PropertiesUtil.getIgnoreCase(mailProps, "smtp.username");
		final String password = PropertiesUtil.getIgnoreCase(mailProps, "smtp.password");
		
		if (username != null && password != null)
		{
			session = Session.getInstance(mailProps,
				new javax.mail.Authenticator() 
				{
					protected PasswordAuthentication getPasswordAuthentication()
					{
						return new PasswordAuthentication(username, password);
					}
				});
			Logger.instance().debug1(module + " Created AlarmMailer with props: '" 
				+ PropertiesUtil.props2string(mailProps)
				+ "' and username=" + username);
		}
		else
		{
			session = Session.getDefaultInstance(mailProps);
			Logger.instance().info(module + " Created unauthenticaed mailer with props: '"
				+ PropertiesUtil.props2string(mailProps) + "'");
		}
	}

	public synchronized void send(AlarmGroup group, ArrayList messages)
		throws MailerException
	{
		if (session == null)
			makeSession();
		
		if (group.getEmailAddrs().size() == 0)
		{
			Logger.instance().warning(module + " Cannot send alarms for group "
				+ group.getName() + " -- email list empty.");
			return;
		}
		
		try 
		{
			Message message = new MimeMessage(session);
			message.setFrom(new InternetAddress(fromAddr, fromName));
			
			InternetAddress addrs[] = new InternetAddress[group.getEmailAddrs().size()];
			int i=0;
			for(EmailAddr addr : group.getEmailAddrs())
				addrs[i++] = new InternetAddress(addr.getAddr());
				
			message.setRecipients(Message.RecipientType.TO, addrs);
			
			message.setSubject("Automated Alarms for group " + group.getName());
			
			StringBuilder sb = new StringBuilder();
			sb.append("The following alarms have been generated for group " + group.getName()
				+ "\n\n");
			for(String msg : messages)
				sb.append(msg + "\n\n");
			String emailText = sb.toString();
			message.setText(emailText);
			Transport.send(message);
			Logger.instance().info(module + " Sent email with text: " + emailText);
 
		}
		catch (Exception ex) 
		{
			throw new MailerException("Error sending mail: " + ex.toString());
		}
	}
}