org.apache.naming.factory.SendMailFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tomcat-catalina
Tomcat Servlet Engine Core Classes and Standard implementations
There is a newer version: 11.0.1
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.naming.factory;

import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Properties;

import javax.naming.Context;
import javax.naming.Name;
import javax.naming.RefAddr;
import javax.naming.Reference;
import javax.naming.spi.ObjectFactory;

import jakarta.mail.Session;
import jakarta.mail.internet.InternetAddress;
import jakarta.mail.internet.MimeMessage;
import jakarta.mail.internet.MimePartDataSource;

import org.apache.tomcat.util.ExceptionUtils;

/**
 * Factory class that creates a JNDI named javamail MimePartDataSource
 * object which can be used for sending email using SMTP.
 * 
 * Can be configured in the Context scope
 * of your server.xml configuration file.
 * 

 * Example:
 * 
 * <Resource name="mail/send" auth="CONTAINER"
 *           type="jakarta.mail.internet.MimePartDataSource"/>
 * <ResourceParams name="mail/send">
 *   <parameter><name>factory</name>
 *     <value>org.apache.naming.factory.SendMailFactory</value>
 *   </parameter>
 *   <parameter><name>mail.smtp.host</name>
 *     <value>your.smtp.host</value>
 *   </parameter>
 *   <parameter><name>mail.smtp.user</name>
 *     <value>someuser</value>
 *   </parameter>
 *   <parameter><name>mail.from</name>
 *     <value>[email protected]</value>
 *   </parameter>
 *   <parameter><name>mail.smtp.sendpartial</name>
 *     <value>true</value>
 *   </parameter>
 *  <parameter><name>mail.smtp.dsn.notify</name>
 *     <value>FAILURE</value>
 *   </parameter>
 *   <parameter><name>mail.smtp.dsn.ret</name>
 *     <value>FULL</value>
 *   </parameter>
 * </ResourceParams>
 * 
 *
 * @author Glenn Nielsen Rich Catlett
 */

public class SendMailFactory implements ObjectFactory
{
    // The class name for the javamail MimeMessageDataSource
    protected static final String DataSourceClassName =
        "jakarta.mail.internet.MimePartDataSource";

    @Override
    public Object getObjectInstance(Object refObj, Name name, Context ctx,
            Hashtable env) throws Exception {
        final Reference ref = (Reference)refObj;

        if (ref.getClassName().equals(DataSourceClassName)) {
            // set up the smtp session that will send the message
            Properties props = new Properties();
            // enumeration of all refaddr
            Enumeration list = ref.getAll();
            // current refaddr to be set
            RefAddr refaddr;
            // set transport to smtp
            props.put("mail.transport.protocol", "smtp");

            while (list.hasMoreElements()) {
                refaddr = list.nextElement();

                // set property
                props.put(refaddr.getType(), refaddr.getContent());
            }
            MimeMessage message = new MimeMessage(
                Session.getInstance(props));
            try {
                RefAddr fromAddr = ref.get("mail.from");
                String from = null;
                if (fromAddr != null) {
                    from = (String) fromAddr.getContent();
                }
                if (from != null) {
                    message.setFrom(new InternetAddress(from));
                }
                message.setSubject("");
            } catch (Throwable t) {
                ExceptionUtils.handleThrowable(t);
                // Otherwise ignore
            }
            MimePartDataSource mds = new MimePartDataSource(message);
            return mds;
        } else { // We can't create an instance of the DataSource
            return null;
        }
    }
}