This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


com.sun.mail.pop3
class DefaultFolder

javax.mail.Folder extended by com.sun.mail.pop3.DefaultFolder

public class DefaultFolder
extends Folder

The POP3 DefaultFolder. Only contains the "INBOX" folder.


Field Summary
 
Fields inherited from class javax.mail.Folder
HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store
 
Method Summary
 void

          Append given Messages to this folder.
 void
close(boolean expunge)

          Close this Folder.
 boolean
create(int type)

          Create this folder on the Store.
 boolean
delete(boolean recurse)

          Delete this Folder.
 boolean

          Tests if this folder physically exists on the Store.
 Message[]

          Expunge (permanently remove) messages marked DELETED.
 Folder

          Return the Folder object corresponding to the given name.
 String

          Returns the full name of this Folder.
protected Folder

          
 Message
getMessage(int msgno)

          Get the Message object corresponding to the given message number.
 int

          Get total number of messages in this Folder.
 String

          Returns the name of this Folder.
 Folder

          Returns the parent folder of this folder.
 Flags

          Get the permanent flags supported by this Folder.
 char

          Return the delimiter character that separates this Folder's pathname from the names of immediate subfolders.
 int

          Returns the type of this Folder, that is, whether this folder can hold messages or subfolders or both.
 boolean

          Returns true if this Folder has new messages since the last time this indication was reset.
 boolean

          Indicates whether this Folder is in the 'open' state.
 Folder[]
list(String pattern)

          Returns a list of Folders belonging to this Folder's namespace that match the specified pattern.
 void
open(int mode)

          Open this Folder.
 boolean

          Rename this Folder.
 
Methods inherited from class javax.mail.Folder
addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, appendMessages, close, copyMessages, create, delete, exists, expunge, fetch, finalize, getDeletedMessageCount, getFolder, getFullName, getMessage, getMessageCount, getMessages, getMessages, getMessages, getMode, getName, getNewMessageCount, getParent, getPermanentFlags, getSeparator, getStore, getType, getUnreadMessageCount, getURLName, hasNewMessages, isOpen, isSubscribed, list, list, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, open, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, renameTo, search, search, setFlags, setFlags, setFlags, setSubscribed, toString
 

Method Detail

appendMessages

public void appendMessages(Message[] msgs)
                    throws MessagingException
Overrides:
appendMessages in class Folder
Parameters:
msgs
Throws:
MessagingException

close

public void close(boolean expunge)
           throws MessagingException
Overrides:
close in class Folder
Parameters:
expunge
Throws:
MessagingException

create

public boolean create(int type)
               throws MessagingException
Overrides:
create in class Folder
Parameters:
type
Throws:
MessagingException

delete

public boolean delete(boolean recurse)
               throws MessagingException
Overrides:
delete in class Folder
Parameters:
recurse
Throws:
MessagingException

exists

public boolean exists()
Overrides:
exists in class Folder

expunge

public Message[] expunge()
                  throws MessagingException
Overrides:
expunge in class Folder
Throws:
MessagingException

getFolder

public Folder getFolder(String name)
                 throws MessagingException
Overrides:
getFolder in class Folder
Parameters:
name
Throws:
MessagingException

getFullName

public String getFullName()
Overrides:
getFullName in class Folder

getInbox

protected Folder getInbox()
                   throws MessagingException
Throws:
MessagingException

getMessage

public Message getMessage(int msgno)
                   throws MessagingException
Overrides:
getMessage in class Folder
Parameters:
msgno
Throws:
MessagingException

getMessageCount

public int getMessageCount()
                    throws MessagingException
Overrides:
getMessageCount in class Folder
Throws:
MessagingException

getName

public String getName()
Overrides:
getName in class Folder

getParent

public Folder getParent()
Overrides:
getParent in class Folder

getPermanentFlags

public Flags getPermanentFlags()
Overrides:
getPermanentFlags in class Folder

getSeparator

public char getSeparator()
Overrides:
getSeparator in class Folder

getType

public int getType()
Overrides:
getType in class Folder

hasNewMessages

public boolean hasNewMessages()
                       throws MessagingException
Overrides:
hasNewMessages in class Folder
Throws:
MessagingException

isOpen

public boolean isOpen()
Overrides:
isOpen in class Folder

list

public Folder[] list(String pattern)
              throws MessagingException
Overrides:
list in class Folder
Parameters:
pattern
Throws:
MessagingException

open

public void open(int mode)
          throws MessagingException
Overrides:
open in class Folder
Parameters:
mode
Throws:
MessagingException

renameTo

public boolean renameTo(Folder f)
                 throws MessagingException
Overrides:
renameTo in class Folder
Parameters:
f
Throws:
MessagingException


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.