All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.mail.MailSessionDefinition Maven / Gradle / Ivy

There is a newer version: 1.6.2
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.mail;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation used by Java EE applications to define a MailSession
 * to be registered with JNDI.  The MailSession may be configured
 * by setting the annotation elements for commonly used Session
 * properties.  Additional standard and vendor-specific properties may be
 * specified using the properties element.
 * 

* The session will be registered under the name specified in the * name element. It may be defined to be in any valid * Java EE namespace, and will determine the accessibility of * the session from other components. * * @since JavaMail 1.5 */ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface MailSessionDefinition { /** * Description of this mail session. * * @return the description */ String description() default ""; /** * JNDI name by which the mail session will be registered. * * @return the JNDI name */ String name(); /** * Store protocol name. * * @return the store protocol name */ String storeProtocol() default ""; /** * Transport protocol name. * * @return the transport protocol name */ String transportProtocol() default ""; /** * Host name for the mail server. * * @return the host name */ String host() default ""; /** * User name to use for authentication. * * @return the user name */ String user() default ""; /** * Password to use for authentication. * * @return the password */ String password() default ""; /** * From address for the user. * * @return the from address */ String from() default ""; /** * Properties to include in the Session. * Properties are specified using the format: * propertyName=propertyValue with one property per array element. * * @return the properties */ String[] properties() default {}; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy