totalcross.net.mail

Class POP3Store

java.lang.Object

totalcross.net.mail.Store

totalcross.net.mail.POP3Store

public class POP3Store
extends Store

A POP3 Message Store. Contains only one folder, "INBOX".

Since:

TotalCross 1.13

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROOT

Fields inherited from class totalcross.net.mail.Store

connection, session, socketFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	POP3Store(MailSession session)

Method Summary

Modifier and Type	Method and Description
void	close() Close this store and terminate its connection.
void	connect() A generic connect method that takes no parameters.
Folder	getDefaultFolder() Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
Folder	getFolder(java.lang.String name) Only the name "INBOX" is supported.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final java.lang.String ROOT

See Also:

Constant Field Values

Constructor Detail

POP3Store

protected POP3Store(MailSession session)

Method Detail

connect

public void connect()
             throws AuthenticationException,
                    MessagingException

Description copied from class: Store

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.

Specified by:

connect in class Store

Throws:

AuthenticationException

MessagingException

getDefaultFolder

public Folder getDefaultFolder()

Description copied from class: Store

Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.

Specified by:

getDefaultFolder in class Store

Returns:

the root Folder

getFolder

public Folder getFolder(java.lang.String name)

Only the name "INBOX" is supported.

Specified by:

getFolder in class Store

Parameters:

name - The name of the Folder. In some Stores, name can be an absolute path if it starts with the hierarchy delimiter. Else it is interpreted relative to the 'root' of this namespace.

Returns:

Folder object

close

public void close()
           throws MessagingException

Description copied from class: Store

Close this store 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.

Specified by:

close in class Store

Throws:

MessagingException