⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
gnu.mail.providers.pop3

Class POP3Folder

java.lang.Object
|
+--javax.mail.Folder
   |
   +--gnu.mail.providers.pop3.POP3Folder


public final class POP3Folder
extends Folder

The folder class implementing the POP3 mail protocol.
Authors:

Constructor Summary

POP3Folder(Store store, int type)

Constructor.

Method Summary

void

appendMessages(Message messages)

You can't append messages to a POP3 folder.

void

close(boolean expunge)

Closes this folder.

boolean

create(int i)

POP3 folders can't be created, deleted, or renamed.

boolean

delete(boolean flag)

POP3 folders can't be created, deleted, or renamed.

boolean

exists()

Indicates whether this folder exists.

Message[]

expunge()

Expunges this folder.

void

fetch(Message messages, FetchProfile fp)

Fetches headers and/or content for the specified messages.

Folder

getFolder(String s)

POP3 folders can't contain subfolders.

String

getFullName()

Returns the full name of this folder.

Message

getMessage(int msgnum)

Returns the specified message from this folder.

int

getMessageCount()

Returns the number of messages in this folder.

String

getName()

Returns the name of this folder.

Folder

getParent()

POP3 folders can't have parents.

Flags

getPermanentFlags()

Returns the permanent flags for this folder.

char

getSeparator()

Returns the path separator charcter.

int

getType()

Returns the type of this folder.

boolean

hasNewMessages()

Indicates whether this folder contains new messages.

boolean

isOpen()

Indicates whether this folder is open.

Folder[]

list()

Returns the subfolders for this folder.

Folder[]

list(String pattern)

Returns the subfolders for this folder.

void

open(int mode)

Opens this folder.

boolean

renameTo(Folder folder)

POP3 folders can't be created, deleted, or renamed.

Constructor Details

POP3Folder

protected POP3Folder(Store store, int type)

Constructor.

Parameters:
store
type

Method Details

appendMessages

public void appendMessages(Message messages)

You can't append messages to a POP3 folder.

Parameters:
messages

close

public void close(boolean expunge)

Closes this folder.

Parameters:
expunge - if the folder is to be expunged before it is closed
Throws:
MessagingException - if a messaging error occurred

create

public boolean create(int i)

POP3 folders can't be created, deleted, or renamed.

Parameters:
i

delete

public boolean delete(boolean flag)

POP3 folders can't be created, deleted, or renamed.

Parameters:
flag

exists

public boolean exists()

Indicates whether this folder exists.

Throws:
MessagingException - if a messaging error occurred

expunge

public Message[] expunge()

Expunges this folder. This deletes all the messages marked as deleted.

Throws:
MessagingException - if a messaging error occurred

fetch

public void fetch(Message messages, FetchProfile fp)

Fetches headers and/or content for the specified messages.

Parameters:
messages
fp
Throws:
MessagingException - ignore

getFolder

public Folder getFolder(String s)

POP3 folders can't contain subfolders.

Parameters:
s

getFullName

public String getFullName()

Returns the full name of this folder.


getMessage

public Message getMessage(int msgnum)

Returns the specified message from this folder.

Parameters:
msgnum - the message number
Throws:
MessagingException - if a messaging error occurred

getMessageCount

public int getMessageCount()

Returns the number of messages in this folder. This results in a STAT call to the POP3 server, so the latest count is always delivered.

Throws:
MessagingException - if a messaging error occurred

getName

public String getName()

Returns the name of this folder.


getParent

public Folder getParent()

POP3 folders can't have parents.


getPermanentFlags

public Flags getPermanentFlags()

Returns the permanent flags for this folder.


getSeparator

public char getSeparator()

Returns the path separator charcter.


getType

public int getType()

Returns the type of this folder.

Throws:
MessagingException - if a messaging error occurred

hasNewMessages

public boolean hasNewMessages()

Indicates whether this folder contains new messages.

Throws:
MessagingException - if a messaging error occurred

isOpen

public boolean isOpen()

Indicates whether this folder is open.


list

public Folder[] list()

Returns the subfolders for this folder.


list

public Folder[] list(String pattern)

Returns the subfolders for this folder.

Parameters:
pattern

open

public void open(int mode)

Opens this folder.

Parameters:
mode
Throws:
MessagingException - if a messaging error occurred

renameTo

public boolean renameTo(Folder folder)

POP3 folders can't be created, deleted, or renamed.

Parameters:
folder