POP3Folder ("The Adobe AEM Quickstart and Web Application.")

java.lang.Object
- Folder
- - com.sun.mail.pop3.POP3Folder

```
public class POP3Folder
extends Folder
```
A POP3 Folder (can only be "INBOX"). See the com.sun.mail.pop3 package documentation for further information on the POP3 protocol provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendMessages(Message[] msgs)` Always throws `MethodNotSupportedException` because the POP3 protocol doesn't support appending messages.
`void`	`close(boolean expunge)`
`boolean`	`create(int type)` Always returns `false`; the POP3 protocol doesn't support creating folders.
`boolean`	`delete(boolean recurse)` Always throws `MethodNotSupportedException` because the POP3 protocol doesn't allow the INBOX to be deleted.
`boolean`	`exists()` Always true for the folder "INBOX", always false for any other name.
`Message[]`	`expunge()` Always throws `MethodNotSupportedException` because the POP3 protocol doesn't support expunging messages without closing the folder; call the `close` method with the `expunge` argument set to `true` instead.
`void`	`fetch(Message[] msgs, FetchProfile fp)` Prefetch information about POP3 messages.
`Folder`	`getFolder(java.lang.String name)` Always throws `MessagingException` because no POP3 folders can contain subfolders.
`java.lang.String`	`getFullName()`
`Message`	`getMessage(int msgno)`
`int`	`getMessageCount()` Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders.
`java.lang.String`	`getName()`
`Folder`	`getParent()`
`Flags`	`getPermanentFlags()` Always returns an empty `Flags` object because the POP3 protocol doesn't support any permanent flags.
`char`	`getSeparator()` Always returns a NUL character because POP3 doesn't support a hierarchy.
`int`	`getSize()` Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened.
`int[]`	`getSizes()` Return the sizes of all messages in this folder, as returned by the POP3 LIST command.
`int`	`getType()` Always returns Folder.HOLDS_MESSAGES.
`java.lang.String`	`getUID(Message msg)` Return the unique ID string for this message, or null if not available.
`boolean`	`hasNewMessages()` Always returns `false`; the POP3 protocol provides no way to determine when a new message arrives.
`boolean`	`isOpen()`
`Folder[]`	`list(java.lang.String pattern)` Always throws `MessagingException` because no POP3 folders can contain subfolders.
`java.io.InputStream`	`listCommand()` Return the raw results of the POP3 LIST command with no arguments.
`void`	`open(int mode)` Throws `FolderNotFoundException` unless this folder is named "INBOX".
`boolean`	`renameTo(Folder f)` Always throws `MethodNotSupportedException` because the POP3 protocol doesn't support multiple folders.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public java.lang.String getName()
```
  - getFullName
```
public java.lang.String getFullName()
```
  - getParent
```
public Folder getParent()
```
  - exists
```
public boolean exists()
```
    Always true for the folder "INBOX", always false for any other name.
    
    Returns:
    
    true for INBOX, false otherwise
  - list
```
public Folder[] list(java.lang.String pattern)
              throws MessagingException
```
    Always throws MessagingException because no POP3 folders can contain subfolders.
    
    Throws:
    
    MessagingException - always
  - getSeparator
```
public char getSeparator()
```
    Always returns a NUL character because POP3 doesn't support a hierarchy.
    
    Returns:
    
    NUL
  - getType
```
public int getType()
```
    Always returns Folder.HOLDS_MESSAGES.
    
    Returns:
    
    Folder.HOLDS_MESSAGES
  - create
```
public boolean create(int type)
               throws MessagingException
```
    Always returns false; the POP3 protocol doesn't support creating folders.
    
    Returns:
    
    false
    
    Throws:
    
    MessagingException
  - hasNewMessages
```
public boolean hasNewMessages()
                       throws MessagingException
```
    Always returns false; the POP3 protocol provides no way to determine when a new message arrives.
    
    Returns:
    
    false
    
    Throws:
    
    MessagingException
  - getFolder
```
public Folder getFolder(java.lang.String name)
                 throws MessagingException
```
    Always throws MessagingException because no POP3 folders can contain subfolders.
    
    Throws:
    
    MessagingException - always
  - delete
```
public boolean delete(boolean recurse)
               throws MessagingException
```
    Always throws MethodNotSupportedException because the POP3 protocol doesn't allow the INBOX to be deleted.
    
    Throws:
    
    MethodNotSupportedException - always
    
    MessagingException
  - renameTo
```
public boolean renameTo(Folder f)
                 throws MessagingException
```
    Always throws MethodNotSupportedException because the POP3 protocol doesn't support multiple folders.
    
    Throws:
    
    MethodNotSupportedException - always
    
    MessagingException
  - open
```
public void open(int mode)
          throws MessagingException
```
    Throws FolderNotFoundException unless this folder is named "INBOX".
    
    Throws:
    
    FolderNotFoundException - if not INBOX
    
    AuthenticationException - authentication failures
    
    MessagingException - other open failures
  - close
```
public void close(boolean expunge)
           throws MessagingException
```
    Throws:
    
    MessagingException
  - isOpen
```
public boolean isOpen()
```
  - getPermanentFlags
```
public Flags getPermanentFlags()
```
    Always returns an empty Flags object because the POP3 protocol doesn't support any permanent flags.
    
    Returns:
    
    empty Flags object
  - getMessageCount
```
public int getMessageCount()
                    throws MessagingException
```
    Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders.
    
    Throws:
    
    MessagingException
  - getMessage
```
public Message getMessage(int msgno)
                   throws MessagingException
```
    Throws:
    
    MessagingException
  - appendMessages
```
public void appendMessages(Message[] msgs)
                    throws MessagingException
```
    Always throws MethodNotSupportedException because the POP3 protocol doesn't support appending messages.
    
    Throws:
    
    MethodNotSupportedException - always
    
    MessagingException
  - expunge
```
public Message[] expunge()
                  throws MessagingException
```
    Always throws MethodNotSupportedException because the POP3 protocol doesn't support expunging messages without closing the folder; call the close method with the expunge argument set to true instead.
    
    Throws:
    
    MethodNotSupportedException - always
    
    MessagingException
  - fetch
```
public void fetch(Message[] msgs,
                  FetchProfile fp)
           throws MessagingException
```
    Prefetch information about POP3 messages. If the FetchProfile contains UIDFolder.FetchProfileItem.UID, POP3 UIDs for all messages in the folder are fetched using the POP3 UIDL command. If the FetchProfile contains FetchProfile.Item.ENVELOPE, the headers and size of all messages are fetched using the POP3 TOP and LIST commands.
    
    Throws:
    
    MessagingException
  - getUID
```
public java.lang.String getUID(Message msg)
                        throws MessagingException
```
    Return the unique ID string for this message, or null if not available. Uses the POP3 UIDL command.
    
    Returns:
    
    unique ID string
    
    Throws:
    
    MessagingException
  - getSize
```
public int getSize()
            throws MessagingException
```
    Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened.
    
    Returns:
    
    folder size
    
    Throws:
    
    java.lang.IllegalStateException - if the folder isn't open
    
    MessagingException
  - getSizes
```
public int[] getSizes()
               throws MessagingException
```
    Return the sizes of all messages in this folder, as returned by the POP3 LIST command. Each entry in the array corresponds to a message; entry i corresponds to message number i+1.
    
    Returns:
    
    array of message sizes
    
    Throws:
    
    java.lang.IllegalStateException - if the folder isn't open
    
    MessagingException
    
    Since:
    
    JavaMail 1.3.3
  - listCommand
```
public java.io.InputStream listCommand()
                                throws MessagingException,
                                       java.io.IOException
```
    Return the raw results of the POP3 LIST command with no arguments.
    
    Returns:
    
    InputStream containing results
    
    Throws:
    
    java.lang.IllegalStateException - if the folder isn't open
    
    MessagingException
    
    java.io.IOException
    
    Since:
    
    JavaMail 1.3.3

Class POP3Folder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getFullName

getParent

exists

list

getSeparator

getType

create

hasNewMessages

getFolder

delete

renameTo

open

close

isOpen

getPermanentFlags

getMessageCount

getMessage

appendMessages

expunge

fetch

getUID

getSize

getSizes

listCommand