totalcross.net.mail

Class POP3Folder

java.lang.Object

totalcross.net.mail.Folder

totalcross.net.mail.POP3Folder

public class POP3Folder
extends Folder

A POP3 Folder (can only be "INBOX").

Since:

TotalCross 1.13

Field Summary

Fields inherited from class totalcross.net.mail.Folder

deletedMessageCount, expungedMessages, HEADER_BUFFER_SIZE, messageCount, messagesByNumber, messagesByUidl, msgHeaderBuffer, store

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	POP3Folder(Store store)

Method Summary

Modifier and Type	Method and Description
Message	getMessage(int msgNumber) Get the Message object corresponding to the given message number.
Message	getMessage(java.lang.String uidl)
void	open() Open this Folder.
void	reset() Reset this session, undoing any operations performed over messages on this folder during this session.

Methods inherited from class totalcross.net.mail.Folder

close, getDeleteMessageCount, getMessageCount, getMessages, getMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

POP3Folder

protected POP3Folder(Store store)

Method Detail

open

public void open()
          throws MessagingException

Description copied from class: Folder

Open this Folder. This method is valid only on Folders that can contain Messages and that are closed.

Specified by:

open in class Folder

Throws:

MessagingException

getMessage

public Message getMessage(int msgNumber)
                   throws MessagingException

Description copied from class: Folder

Get the Message object corresponding to the given message number. A Message object's message number is the relative position of this Message in its Folder. Messages are numbered starting at 1 through the total number of message in the folder. Note that the message number for a particular Message can change during a session if other messages in the Folder are deleted and the Folder is expunged. Message objects are light-weight references to the actual message that get filled up on demand. Hence Folder implementations are expected to provide light-weight Message objects. Unlike Folder objects, repeated calls to getMessage with the same message number will return the same Message object, as long as no messages in this folder have been expunged. Since message numbers can change within a session if the folder is expunged, clients are advised not to use message numbers as references to messages. Use Message objects instead.

Specified by:

getMessage in class Folder

Parameters:

msgNumber - the message number

Returns:

the Message object

Throws:

MessagingException

getMessage

public Message getMessage(java.lang.String uidl)
                   throws MessagingException

Specified by:

getMessage in class Folder

Throws:

MessagingException

reset

public void reset()
           throws MessagingException

Description copied from class: Folder

Reset this session, undoing any operations performed over messages on this folder during this session.

Specified by:

reset in class Folder

Throws:

MessagingException