Top Description Methods
javax.mail

public @Interface MailSessionDefinition

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
@Repeatable:MailSessionDefinitions
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target, .Repeatable
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

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the description
description()

Description of this mail session.

public String

Returns:

the from address
from()

From address for the user.

public String

Returns:

the host name
host()

Host name for the mail server.

public String

Returns:

the JNDI name
name()

JNDI name by which the mail session will be registered.

public String

Returns:

the password
password()

Password to use for authentication.

public String[]

Returns:

the properties
properties()

Properties to include in the Session.

public String

Returns:

the store protocol name
storeProtocol()

Store protocol name.

public String

Returns:

the transport protocol name
transportProtocol()

Transport protocol name.

public String

Returns:

the user name
user()

User name to use for authentication.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public String description()

Description of this mail session.

Returns:String

the description

fromback to summary
public String from()

From address for the user.

Returns:String

the from address

hostback to summary
public String host()

Host name for the mail server.

Returns:String

the host name

nameback to summary
public String name()

JNDI name by which the mail session will be registered.

Returns:String

the JNDI name

passwordback to summary
public String password()

Password to use for authentication.

Returns:String

the password

propertiesback to summary
public String[] properties()

Properties to include in the Session. Properties are specified using the format: propertyName=propertyValue with one property per array element.

Returns:String[]

the properties

storeProtocolback to summary
public String storeProtocol()

Store protocol name.

Returns:String

the store protocol name

transportProtocolback to summary
public String transportProtocol()

Transport protocol name.

Returns:String

the transport protocol name

userback to summary
public String user()

User name to use for authentication.

Returns:String

the user name