-
@Target(value=TYPE) @Retention(value=RUNTIME) public @interface MailSessionDefinition
Annotation used by Java EE applications to define aMailSession
to be registered with JNDI. TheMailSession
may be configured by setting the annotation elements for commonly usedSession
properties. Additional standard and vendor-specific properties may be specified using theproperties
element. The session will be registered under the name specified in thename
element. It may be defined to be in any validJava EE
namespace, and will determine the accessibility of the session from other components.- Since:
- JavaMail 1.5
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description String
name
JNDI name by which the mail session will be registered.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description String
description
Description of this mail session.String
from
From address for the user.String
host
Host name for the mail server.String
password
Password to use for authentication.String[]
properties
Properties to include in the Session.String
storeProtocol
Store protocol name.String
transportProtocol
Transport protocol name.String
user
User name to use for authentication.
-
-
-
Element Detail
-
name
public abstract String name
JNDI name by which the mail session will be registered.
-
-
-
description
public abstract String description
Description of this mail session.- Default:
- ""
-
-
-
storeProtocol
public abstract String storeProtocol
Store protocol name.- Default:
- ""
-
-
-
transportProtocol
public abstract String transportProtocol
Transport protocol name.- Default:
- ""
-
-
-
host
public abstract String host
Host name for the mail server.- Default:
- ""
-
-
-
user
public abstract String user
User name to use for authentication.- Default:
- ""
-
-
-
password
public abstract String password
Password to use for authentication.- Default:
- ""
-
-
-
from
public abstract String from
From address for the user.- Default:
- ""
-
-
-
properties
public abstract String[] properties
Properties to include in the Session. Properties are specified using the format: propertyName=propertyValue with one property per array element.- Default:
- {}
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/mail/MailSessionDefinition.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.