SendMailFactory (Apache Tomcat 9.0.37 API Documentation)

org.apache.naming.factory

## Class SendMailFactory

- java.lang.Object
- - org.apache.naming.factory.SendMailFactory

- All Implemented Interfaces:
    ObjectFactory

      public class SendMailFactory
      extends Object
      implements ObjectFactory

  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="javax.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>someuser@some.host</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

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected static String` | `DataSourceClassName`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SendMailFactory()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Object` | `getObjectInstance(Object refObj, Name name, Context ctx, Hashtable<?,?> env)`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### DataSourceClassName

          protected static final String DataSourceClassName

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### SendMailFactory

          public SendMailFactory()

  - ### Method Detail

    - #### getObjectInstance

          public Object getObjectInstance(Object refObj,
                                          Name name,
                                          Context ctx,
                                          Hashtable<?,?> env)
                                   throws Exception

      Specified by:
        `getObjectInstance` in interface `ObjectFactory`
      Throws:
        `Exception`

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.