Movatterモバイル変換

Class Session

java.lang.Object  |  +--javax.mail.Session

public final classSession

extends java.lang.Object

The Session class represents a mail session and is not subclassed. It collects together properties and defaults used by the mail API's. A single default session can be shared by multiple applications on the desktop. Unshared sessions can also be created.

getInstance

public staticSessiongetInstance(java.util.Properties props,Authenticator authenticator)

Get a new Session object.

Parameters:

props - Properties object that hold relevant properties.
It is expected that the client supplies values for the properties listed in Appendix A of the JavaMail spec (particularly mail.store.protocol, mail.transport.protocol, mail.host, mail.user, and mail.from) as the defaults are unlikely to work in all cases.

authenticator - Authenticator object used to call back tothe application when a user name and password isneeded.

Returns:

a new Session object

See Also:

Authenticator

getDefaultInstance

public staticSessiongetDefaultInstance(java.util.Properties props,Authenticator authenticator)

Get the default Session object. If a default has not yet been setup, a new Session object is created and installed as the default.

Since the default session is potentially available to all code executing in the same Java virtual machine, and the session can contain security sensitive information such as user names and passwords, access to the default session is restricted. The Authenticator object, which must be created by the caller, is used indirectly to check access permission. The Authenticator object passed in when the session is created is compared with the Authenticator object passed in to subsequent requests to get the default session. If both objects are the same, or are from the same ClassLoader, the request is allowed. Otherwise, it is denied.

Note that if the Authenticator object used to create the session is null, anyone can get the default session by passing in null.

In JDK 1.2, additional security Permission objects may be used to control access to the default session.

Parameters:

props - Properties object. Used only if a new Sessionobject is created.
It is expected that the client supplies values for the properties listed in Appendix A of the JavaMail spec (particularly mail.store.protocol, mail.transport.protocol, mail.host, mail.user, and mail.from) as the defaults are unlikely to work in all cases.

authenticator - Authenticator object. Used only if anew Session object is created. Otherwise, it must match the Authenticator used to createthe Session.

Returns:

the default Session object

setDebug

public voidsetDebug(boolean debug)

Set the debug setting for this Session.

Since debug can be turned on only after the Session has been created, to turn on debugging in the Session constructor, set the propertymail.debug to true. Subsequent calls to get/setDebug() have no affect on and override themail.debug property.

Parameters:

debug - Debug setting

getDebug

public booleangetDebug()

Get the debug setting for this Session.

Since debug can be turned on only after the Session has been created, to turn on debugging in the Session constructor, set the propertymail.debug to true. Subsequent calls to get/setDebug() have no affect on and override themail.debug property.

Returns:

current debug setting

getProviders

publicProvider[]getProviders()

This method returns an array of all the implementations installed via the javamail.[default.]providers files that can be loaded using the ClassLoader available to this application.

Returns:

Array of configured providers

getProvider

publicProvidergetProvider(java.lang.String protocol)                     throwsNoSuchProviderException

Returns the default Provider for the protocol specified. Checks mail.<protocol>.class property first and if it exists, returns the Provider associated with this implementation. If it doesn't exist, returns the Provider that appeared first in the configuration files. If an implementation for the protocol isn't found, throws NoSuchProviderException

Parameters:

protocol - Configured protocol (i.e. smtp, imap, etc)

Returns:

Currently configured Provider for the specified protocol

Throws:

NoSuchProviderException - If a provider for the givenprotocol is not found.

setProvider

public voidsetProvider(Provider provider)                 throwsNoSuchProviderException

Set the passed Provider to be the default implementation for the protocol in Provider.protocol overriding any previous values.

Parameters:

provider - Currently configured Provider which will be set as the default for the protocol

Throws:

NoSuchProviderException - If the provider passed inis invalid.

getStore

publicStoregetStore()               throwsNoSuchProviderException

Get a Store object that implements this user's desired Store protcol. Themail.store.protocol property specifies the desired protocol. If an appropriate Store object is not obtained, NoSuchProviderException is thrown

Returns:

a Store object

Throws:

NoSuchProviderException - If a provider for the givenprotocol is not found.

getStore

publicStoregetStore(java.lang.String protocol)               throwsNoSuchProviderException

Get a Store object that implements the specified protocol. If an appropriate Store object cannot be obtained, NoSuchProviderException is thrown.

Parameters:

protocol -  

Returns:

a Store object

Throws:

NoSuchProviderException - If a provider for the givenprotocol is not found.

getStore

publicStoregetStore(URLName url)               throwsNoSuchProviderException

Get a Store object for the given URLName. If the requested Store object cannot be obtained, NoSuchProviderException is thrown. The "scheme" part of the URL string (Refer RFC 1738) is used to locate the Store protocol.

Parameters:

url - URLName that represents the desired Store

Returns:

a closed Store object

Throws:

NoSuchProviderException - If a provider for the givenURLName is not found.

See Also:

getFolder(URLName),URLName

getStore

publicStoregetStore(Provider provider)               throwsNoSuchProviderException

Get an instance of the store specified by Provider. Instantiates the store and returns it.

Parameters:

provider - Store Provider that will be instantiated

Returns:

Instantiated Store

Throws:

NoSuchProviderException - If a provider for the givenProvider is not found.

getFolder

publicFoldergetFolder(URLName url)                 throwsMessagingException

Get a closed Folder object for the given URLName. If the requested Folder object cannot be obtained, null is returned.

The "scheme" part of the URL string (Refer RFC 1738) is used to locate the Store protocol. The rest of the URL string (ie the "schemepart", as per RFC 1738) is used by that Store in a protocol dependent manner to locate and instantiate the appropriate Folder object.

Note that RFC 1738 also specifies the syntax for the "schemepart" for IP-based protocols (IMAP4, POP3 etc). So providers of IP-based mail Stores should implement that syntax for referring to Folders.

Parameters:

url - URLName that represents the desired folder

Returns:

Folder

Throws:

NoSuchProviderException - If a provider for the givenURLName is not found.

MessagingException - if the Folder could not be located or created.

See Also:

getStore(URLName),URLName

getTransport

publicTransportgetTransport()                       throwsNoSuchProviderException

Get a Transport object that implements this user's desired Transport protcol. Themail.transport.protocol property specifies the desired protocol. If an appropriate Transport object cannot be obtained, MessagingException is thrown.

Returns:

a Transport object

Throws:

NoSuchProviderException - If the provider is not found.

getTransport

publicTransportgetTransport(java.lang.String protocol)                       throwsNoSuchProviderException

Get a Transport object that implements the specified protocol. If an appropriate Transport object cannot be obtained, null is returned.

Returns:

a Transport object

Throws:

NoSuchProviderException - If provider for the givenprotocol is not found.

getTransport

publicTransportgetTransport(URLName url)                       throwsNoSuchProviderException

Get a Transport object for the given URLName. If the requested Transport object cannot be obtained, NoSuchProviderException is thrown. The "scheme" part of the URL string (Refer RFC 1738) is used to locate the Transport protocol.

Parameters:

url - URLName that represents the desired Transport

Returns:

a closed Transport object

Throws:

NoSuchProviderException - If a provider for the givenURLName is not found.

See Also:

URLName

getTransport

publicTransportgetTransport(Provider provider)                       throwsNoSuchProviderException

Get an instance of the transport specified in the Provider. Instantiates the transport and returns it.

Parameters:

provider - Transport Provider that will be instantiated

Returns:

Instantiated Transport

Throws:

NoSuchProviderException - If provider for the givenprovider is not found.

getTransport

publicTransportgetTransport(Address address)                       throwsNoSuchProviderException

Get a Transport object that can transport a Message to the specified address type.

Parameters:

address -  

Returns:

A Transport object

Throws:

NoSuchProviderException - If provider for the Address type is not found

See Also:

Address

setPasswordAuthentication

public voidsetPasswordAuthentication(URLName url,PasswordAuthentication pw)

Save a PasswordAuthentication for this (store or transport) URLName. If pw is null the entry corresponding to the URLName is removed.

This is normally used only by the store or transport implementations to allow authentication information to be shared among multiple uses of a session.

getPasswordAuthentication

publicPasswordAuthenticationgetPasswordAuthentication(URLName url)

Return any saved PasswordAuthentication for this (store or transport) URLName. Normally used only by store or transport implementations.

Returns:

the PasswordAuthentication corresponding to the URLName

requestPasswordAuthentication

publicPasswordAuthenticationrequestPasswordAuthentication(java.net.InetAddress addr,                                                            int port,                                                            java.lang.String protocol,                                                            java.lang.String prompt,                                                            java.lang.String defaultUserName)

Call back to the application to get the needed user name and password. The application should put up a dialog something like:

 Connecting to <protocol> mail service on host <addr>, port <port>. <prompt> User Name: <defaultUserName> Password:

Parameters:

addr - InetAddress of the host. may be null.

protocol - protocol scheme (e.g. imap, pop3, etc.)

prompt - any additional String to show as part of the prompt; may be null.

defaultUserName - the default username. may be null.

Returns:

the authentication which was collected by the authenticator; may be null.

getProperties

public java.util.PropertiesgetProperties()

Returns the Properties object associated with this Session

Returns:

Properties object

getProperty

public java.lang.StringgetProperty(java.lang.String name)

Returns the value of the specified property. Returns null if this property does not exist.

Returns:

String that is the property value