javax.mail
public final class Session extends Object
Version: 1.4
Method Summary | |
---|---|
void | addProvider(Provider provider)
Adds the specified provider to the session. |
boolean | getDebug()
Get the debug setting for this Session. |
PrintStream | getDebugOut()
Returns the stream to be used for debugging output. |
static Session | getDefaultInstance(Properties props, Authenticator authenticator)
Returns the default session.
|
static Session | getDefaultInstance(Properties props)
Get the default Session object.
|
Folder | getFolder(URLName url)
Get a closed Folder object for the given URLName.
|
static Session | getInstance(Properties props, Authenticator authenticator)
Returns a new session. |
static Session | getInstance(Properties props)
Returns a new Session. |
PasswordAuthentication | getPasswordAuthentication(URLName url)
Return any saved PasswordAuthentication for this(store or transport)
URLName. |
Properties | getProperties()
Returns the Properties object associated with this Session. |
String | getProperty(String name)
Returns the value of the specified property.
|
Provider | getProvider(String protocol)
Returns the default Provider for the protocol specified.
|
Provider[] | 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. |
Store | getStore()
Get a Store object that implements this user's desired Store protocol.
|
Store | getStore(String protocol)
Get a Store object that implements the specified protocol.
|
Store | getStore(URLName url)
Get a Store object for the given URLName.
|
Store | getStore(Provider provider)
Get an instance of the store specified by Provider.
|
Transport | getTransport()
Get a Transport object that implements this user's desired Transport
protocol.
|
Transport | getTransport(String protocol)
Get a Transport object that implements the specified protocol.
|
Transport | getTransport(URLName url)
Get a Transport object for the given URLName.
|
Transport | getTransport(Provider provider)
Get an instance of the transport specified in the Provider.
|
Transport | getTransport(Address address)
Get a Transport object that can transport a Message to the specified
address type. |
PasswordAuthentication | requestPasswordAuthentication(InetAddress address, int port, String protocol, String prompt, String defaultUserName)
Call back to the application to get the needed user name and password.
|
void | setDebug(boolean debug)
Set the debug setting for this Session.
|
void | setDebugOut(PrintStream out)
Set the stream to be used for debugging output for this session.
|
void | setPasswordAuthentication(URLName url, PasswordAuthentication pw)
Save a PasswordAuthentication for this(store or transport) URLName.
|
void | setProtocolForAddress(String addressType, String protocol)
Sets the default transport protocol for the given address type. |
void | setProvider(Provider provider)
Set the passed Provider to be the default implementation for the protocol
in Provider.protocol overriding any previous values. |
Parameters: provider the new provider
Since: JavaMail 1.4
System.out
is returned.Since: JavaMail 1.3
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 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 to the
application when a user name and password is needed.
Note that a default session created with no Authenticator is 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.
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.
The "scheme" part of the URL string(Refer RFC 1738) is used to locate the Store protocol. The rest of the URL string(that is, 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.). Providers of IP-based mail Stores should implement that syntax for referring to Folders.
Parameters: url URLName that represents the desired folder MessagingException if the Folder could not be located or created.
Throws: NoSuchProviderException If a provider for the given URLName is not found.
Parameters: props a properties object holding 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 an authenticator used to call back to the
application when a user name and password is needed.
Parameters: props a properties object holding 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.
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 NoSuchProviderExceptionParameters: protocol Configured protocol(i.e. smtp, imap, etc) NoSuchProviderException If a provider for the given protocol is not found.
mail.store.protocol
property specifies the desired
protocol. If an appropriate Store object is not obtained,
NoSuchProviderException is thrownParameters: url URLName that represents the desired Store
Parameters: provider Store Provider that will be instantiated
mail.transport.protocol
property specifies the desired
protocol. If an appropriate Transport object cannot be obtained,
MessagingException is thrown.Throws: NoSuchProviderException If the provider is not found.
Throws: NoSuchProviderException If the provider is not found.
Parameters: url URLName that represents the desired Transport
Throws: NoSuchProviderException If the provider is not found.
Throws: NoSuchProviderException If the provider is not found.
Throws: NoSuchProviderException If the provider is not found.
Connecting tomail service on host , port . User Name: 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.
Since the debug setting can be turned on only after the Session has been
created, to turn on debugging in the Session constructor, set the property
mail.debug
in the Properties object passed in to the
constructor to true. The value of the mail.debug
property
is used to initialize the per-Session debugging flag. Subsequent calls
to the setDebug
method manipulate the per-Session debugging
flag and have no affect on the mail.debug
property.
out
is null, System.out
will be used. Note
that debugging output that occurs before any session is created, as a
result of setting the mail.debug
property, will always be
sent to System.out
.Parameters: out the PrintStream to use for debugging output
Since: JavaMail 1.3
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.
Parameters: addressType the type of address, e.g. "rfc822" protocol the transport protocol to use
Since: JavaMail 1.4