com.globalmentor.mail.MailManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalmentor-mail Show documentation
GlobalMentor Java mail library.
The newest version!
/*
 * Copyright © 1996-2008 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.globalmentor.mail;

import java.util.*;
import java.util.concurrent.*;

import javax.mail.*;

import static com.globalmentor.mail.Mail.*;
import static com.globalmentor.util.PropertiesUtilities.*;

/**
 * A class for managing mail with asynchronous sending.
 * @author Garret Wilson
 */
public class MailManager {

	/** The session used for sending mail. */
	private final Session session;

	/** @return The session used for sending mail. */
	public Session getSession() {
		return session;
	}

	/** The queue for sending mail. */
	private final BlockingQueue sendQueue;

	/** @return The queue for sending mail. */
	public BlockingQueue getSendQueue() {
		return sendQueue;
	}

	/** The consumer that sends mail placed in the queue. */
	private final BlockingQueueMailSender mailSender;

	/** @return The consumer that sends mail placed in the queue. */
	protected BlockingQueueMailSender getMailSender() {
		return mailSender;
	}

	/** The thread for asynchronous sending. */
	private final Thread sendThread;

	/** The thread for asynchronous sending. */
	public Thread getSendThread() {
		return sendThread;
	}

	/**
	 * Properties constructor. The transport protocol should be specified in the {@value Mail#MAIL_TRANSPORT_PROTOCOL_PROPERTY} property. Besides the default
	 * JavaMail properties, this implementation expects the mail authentication user to be specified in the mail.transport.user property
	 * and the mail authentication password to be specified in the mail.transport.password property
	 * @param properties The map of JavaMail properties used to initialize the mail session.
	 * @throws NullPointerException if the given properties is null.
	 * @throws NoSuchProviderException if the provider specified in the properties cannot be found.
	 */
	public MailManager(final Map properties) throws NoSuchProviderException {
		session = Session.getInstance(toProperties(properties)); //create a new mail session
		final String transportProtocol = (String)properties.get(MAIL_TRANSPORT_PROTOCOL_PROPERTY); //get the transport protocol
		final String user = (String)properties.get(MAIL_PROTOCOL_USER_PROPERTY_TEMPLATE.apply(transportProtocol)); //get the user for the transport protocol
		final String password = (String)properties.get(MAIL_PROTOCOL_PASSWORD_PROPERTY_TEMPLATE.apply(transportProtocol)); //get the password for the transport protocol
		sendQueue = new LinkedBlockingQueue(); //create a new queue for sending mail messages
		mailSender = new BlockingQueueMailSender(sendQueue, session.getTransport(), user, password); //create the mail sender
		sendThread = new Thread(mailSender, getClass().getSimpleName()); //create a new send thread
		sendThread.setDaemon(true); //make the send thread a daemon so that it won't hold up the application when the system shuts down
		sendThread.start(); //start the send thread
	}
}