Package totalcross.net.mail

Class Service

java.lang.Object

totalcross.net.mail.Service

Direct Known Subclasses:

Transport

public abstract class Service
extends java.lang.Object

An abstract class that models a message store and its access protocol, for storing and retrieving messages. Subclasses provide actual implementations.

Since:

TotalCross 1.13

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	host
protected java.lang.String	password
protected int	port
protected MailSession	session
protected java.lang.String	user

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Service(MailSession session)

Method Summary

Modifier and Type	Method	Description
abstract void	close()	Close this service and terminate its connection.
abstract void	connect()	A generic connect method that takes no parameters.
abstract void	connect(java.lang.String host, int port, java.lang.String user, java.lang.String password)
protected void	protocolConnect(java.lang.String host, int port, java.lang.String login, java.lang.String password)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

session

protected MailSession session

host

protected java.lang.String host

port

protected int port

user

protected java.lang.String user

password

protected java.lang.String password

Constructor Detail

Service

protected Service(MailSession session)

Method Detail

connect

public abstract void connect()
                      throws AuthenticationException,
                             MessagingException

A generic connect method that takes no parameters. Subclasses can implement the appropriate authentication schemes. Subclasses that need additional information might want to use some properties or might get it interactively. Most clients should just call this method to connect to the store.

Throws:

AuthenticationException

MessagingException

Since:

TotalCross 1.13

connect

public abstract void connect(java.lang.String host,
                             int port,
                             java.lang.String user,
                             java.lang.String password)
                      throws AuthenticationException,
                             MessagingException

Throws:

AuthenticationException

MessagingException

close

public abstract void close()
                    throws MessagingException

Close this service and terminate its connection. Any Messaging components (Folders, Messages, etc.) belonging to this service are invalid after this store is closed. Note that the store is closed even if this method terminates abnormally by throwing a MessagingException.

Throws:

MessagingException

Since:

TotalCross 1.13

protocolConnect

protected void protocolConnect(java.lang.String host,
                               int port,
                               java.lang.String login,
                               java.lang.String password)
                        throws AuthenticationException,
                               MessagingException

Throws:

AuthenticationException

MessagingException