Package jakarta.mail
Annotation Type MailSessionDefinition
- 
 @Target(TYPE) @Retention(RUNTIME) @Repeatable(MailSessionDefinitions.class) public @interface MailSessionDefinition Annotation used by Jakarta EE applications to define aMailSessionto be registered with JNDI. TheMailSessionmay be configured by setting the annotation elements for commonly usedSessionproperties. Additional standard and vendor-specific properties may be specified using thepropertieselement.The session will be registered under the name specified in the nameelement. It may be defined to be in any validJakarta EEnamespace, and will determine the accessibility of the session from other components.- Since:
- JavaMail 1.5
 
- 
- 
Optional Element SummaryOptional Elements Modifier and Type Optional Element Description StringdescriptionDescription of this mail session.StringfromFrom address for the user.StringhostHost name for the mail server.StringpasswordPassword to use for authentication.String[]propertiesProperties to include in the Session.StringstoreProtocolStore protocol name.StringtransportProtocolTransport protocol name.StringuserUser name to use for authentication.
 
- 
- 
- 
Element Detail- 
nameString name JNDI name by which the mail session will be registered.- Returns:
- the JNDI name
 
 
- 
 - 
- 
descriptionString description Description of this mail session.- Returns:
- the description
 - Default:
- ""
 
 
- 
 - 
- 
storeProtocolString storeProtocol Store protocol name.- Returns:
- the store protocol name
 - Default:
- ""
 
 
- 
 - 
- 
transportProtocolString transportProtocol Transport protocol name.- Returns:
- the transport protocol name
 - Default:
- ""
 
 
- 
 - 
- 
hostString host Host name for the mail server.- Returns:
- the host name
 - Default:
- ""
 
 
- 
 - 
- 
userString user User name to use for authentication.- Returns:
- the user name
 - Default:
- ""
 
 
- 
 - 
- 
passwordString password Password to use for authentication.- Returns:
- the password
 - Default:
- ""
 
 
- 
 - 
- 
fromString from From address for the user.- Returns:
- the from address
 - Default:
- ""
 
 
- 
 - 
- 
propertiesString[] properties Properties to include in the Session. Properties are specified using the format: propertyName=propertyValue with one property per array element.- Returns:
- the properties
 - Default:
- {}
 
 
- 
 
-