Java Doc for POP3Folder.java in  » EJB-Server-GlassFish » mail » com » sun » mail » pop3 » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » EJB Server GlassFish » mail » com.sun.mail.pop3 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

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


author:
   Bill Shannon
author:
   John Mani (ported to the javax.mail APIs)




Constructor Summary
 POP3Folder(POP3Store store, String name)
    

Method Summary
public  voidappendMessages(Message[] msgs)
     Always throws MethodNotSupportedException because the POP3 protocol doesn't support appending messages.
 voidcheckClosed()
    
 voidcheckOpen()
    
 voidcheckReadable()
    
 voidcheckWritable()
    
public synchronized  voidclose(boolean expunge)
    
public  booleancreate(int type)
     Always returns false; the POP3 protocol doesn't support creating folders.
protected  POP3MessagecreateMessage(Folder f, int msgno)
    
public  booleandelete(boolean recurse)
     Always throws MethodNotSupportedException because the POP3 protocol doesn't allow the INBOX to be deleted.
public  booleanexists()
     Always true for the folder "INBOX", always false for any other name.
public  Message[]expunge()
     Always throws MethodNotSupportedException because the POP3 protocol doesn't support expunging messages without closing the folder; call the POP3Folder.close close method with the expunge argument set to true instead.
public synchronized  voidfetch(Message[] msgs, FetchProfile fp)
     Prefetch information about POP3 messages.
protected  voidfinalize()
     Close the folder when we're finalized.
public  FoldergetFolder(String name)
     Always throws MessagingException because no POP3 folders can contain subfolders.
public  StringgetFullName()
    
public synchronized  MessagegetMessage(int msgno)
    
public synchronized  intgetMessageCount()
     Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders.
public  StringgetName()
    
public  FoldergetParent()
    
public  FlagsgetPermanentFlags()
     Always returns an empty Flags object because the POP3 protocol doesn't support any permanent flags.
 ProtocolgetProtocol()
     Centralize access to the Protocol object by POP3Message objects so that they will fail appropriately when the folder is closed.
public  chargetSeparator()
     Always returns a NUL character because POP3 doesn't support a hierarchy.
public synchronized  intgetSize()
     Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened.
public synchronized  int[]getSizes()
     Return the sizes of all messages in this folder, as returned by the POP3 LIST command.
public  intgetType()
     Always returns Folder.HOLDS_MESSAGES.
public synchronized  StringgetUID(Message msg)
     Return the unique ID string for this message, or null if not available.
public  booleanhasNewMessages()
     Always returns false; the POP3 protocol provides no way to determine when a new message arrives.
public  booleanisOpen()
    
public  Folder[]list(String pattern)
     Always throws MessagingException because no POP3 folders can contain subfolders.
public synchronized  InputStreamlistCommand()
     Return the raw results of the POP3 LIST command with no arguments.
protected  voidnotifyMessageChangedListeners(int type, Message m)
    
public synchronized  voidopen(int mode)
     Throws FolderNotFoundException unless this folder is named "INBOX".
public  booleanrenameTo(Folder f)
     Always throws MethodNotSupportedException because the POP3 protocol doesn't support multiple folders.


Constructor Detail
POP3Folder
POP3Folder(POP3Store store, String name)(Code)




Method Detail
appendMessages
public void appendMessages(Message[] msgs) throws MessagingException(Code)
Always throws MethodNotSupportedException because the POP3 protocol doesn't support appending messages.
exception:
  MethodNotSupportedException - always



checkClosed
void checkClosed() throws IllegalStateException(Code)



checkOpen
void checkOpen() throws IllegalStateException(Code)



checkReadable
void checkReadable() throws IllegalStateException(Code)



checkWritable
void checkWritable() throws IllegalStateException(Code)



close
public synchronized void close(boolean expunge) throws MessagingException(Code)



create
public boolean create(int type) throws MessagingException(Code)
Always returns false; the POP3 protocol doesn't support creating folders. false



createMessage
protected POP3Message createMessage(Folder f, int msgno) throws MessagingException(Code)



delete
public boolean delete(boolean recurse) throws MessagingException(Code)
Always throws MethodNotSupportedException because the POP3 protocol doesn't allow the INBOX to be deleted.
exception:
  MethodNotSupportedException - always



exists
public boolean exists()(Code)
Always true for the folder "INBOX", always false for any other name. true for INBOX, false otherwise



expunge
public Message[] expunge() throws MessagingException(Code)
Always throws MethodNotSupportedException because the POP3 protocol doesn't support expunging messages without closing the folder; call the POP3Folder.close close method with the expunge argument set to true instead.
exception:
  MethodNotSupportedException - always



fetch
public synchronized void fetch(Message[] msgs, FetchProfile fp) throws MessagingException(Code)
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.



finalize
protected void finalize() throws Throwable(Code)
Close the folder when we're finalized.



getFolder
public Folder getFolder(String name) throws MessagingException(Code)
Always throws MessagingException because no POP3 folders can contain subfolders.
exception:
  MessagingException - always



getFullName
public String getFullName()(Code)



getMessage
public synchronized Message getMessage(int msgno) throws MessagingException(Code)



getMessageCount
public synchronized int getMessageCount() throws MessagingException(Code)
Will not change while the folder is open because the POP3 protocol doesn't support notification of new messages arriving in open folders.



getName
public String getName()(Code)



getParent
public Folder getParent()(Code)



getPermanentFlags
public Flags getPermanentFlags()(Code)
Always returns an empty Flags object because the POP3 protocol doesn't support any permanent flags. empty Flags object



getProtocol
Protocol getProtocol() throws MessagingException(Code)
Centralize access to the Protocol object by POP3Message objects so that they will fail appropriately when the folder is closed.



getSeparator
public char getSeparator()(Code)
Always returns a NUL character because POP3 doesn't support a hierarchy. NUL



getSize
public synchronized int getSize() throws MessagingException(Code)
Return the size of this folder, as was returned by the POP3 STAT command when this folder was opened. folder size
exception:
  IllegalStateException - if the folder isn't open



getSizes
public synchronized int[] getSizes() throws MessagingException(Code)
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. array of message sizes
exception:
  IllegalStateException - if the folder isn't open
since:
   JavaMail 1.3.3



getType
public int getType()(Code)
Always returns Folder.HOLDS_MESSAGES. Folder.HOLDS_MESSAGES



getUID
public synchronized String getUID(Message msg) throws MessagingException(Code)
Return the unique ID string for this message, or null if not available. Uses the POP3 UIDL command. unique ID string
exception:
  MessagingException -



hasNewMessages
public boolean hasNewMessages() throws MessagingException(Code)
Always returns false; the POP3 protocol provides no way to determine when a new message arrives. false



isOpen
public boolean isOpen()(Code)



list
public Folder[] list(String pattern) throws MessagingException(Code)
Always throws MessagingException because no POP3 folders can contain subfolders.
exception:
  MessagingException - always



listCommand
public synchronized InputStream listCommand() throws MessagingException, IOException(Code)
Return the raw results of the POP3 LIST command with no arguments. InputStream containing results
exception:
  IllegalStateException - if the folder isn't open
since:
   JavaMail 1.3.3



notifyMessageChangedListeners
protected void notifyMessageChangedListeners(int type, Message m)(Code)



open
public synchronized void open(int mode) throws MessagingException(Code)
Throws FolderNotFoundException unless this folder is named "INBOX".
exception:
  FolderNotFoundException - if not INBOX
exception:
  AuthenticationException - authentication failures
exception:
  MessagingException - other open failures



renameTo
public boolean renameTo(Folder f) throws MessagingException(Code)
Always throws MethodNotSupportedException because the POP3 protocol doesn't support multiple folders.
exception:
  MethodNotSupportedException - always



Fields inherited from javax.mail.Folder
final public static int HOLDS_FOLDERS(Code)(Java Doc)
final public static int HOLDS_MESSAGES(Code)(Java Doc)
final public static int READ_ONLY(Code)(Java Doc)
final public static int READ_WRITE(Code)(Java Doc)
protected int mode(Code)(Java Doc)
protected Store store(Code)(Java Doc)

Methods inherited from javax.mail.Folder
public synchronized void addConnectionListener(ConnectionListener l)(Code)(Java Doc)
public synchronized void addFolderListener(FolderListener l)(Code)(Java Doc)
public synchronized void addMessageChangedListener(MessageChangedListener l)(Code)(Java Doc)
public synchronized void addMessageCountListener(MessageCountListener l)(Code)(Java Doc)
abstract public void appendMessages(Message[] msgs) throws MessagingException(Code)(Java Doc)
abstract public void close(boolean expunge) throws MessagingException(Code)(Java Doc)
public void copyMessages(Message[] msgs, Folder folder) throws MessagingException(Code)(Java Doc)
abstract public boolean create(int type) throws MessagingException(Code)(Java Doc)
abstract public boolean delete(boolean recurse) throws MessagingException(Code)(Java Doc)
abstract public boolean exists() throws MessagingException(Code)(Java Doc)
abstract public Message[] expunge() throws MessagingException(Code)(Java Doc)
public void fetch(Message[] msgs, FetchProfile fp) throws MessagingException(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
public synchronized int getDeletedMessageCount() throws MessagingException(Code)(Java Doc)
abstract public Folder getFolder(String name) throws MessagingException(Code)(Java Doc)
abstract public String getFullName()(Code)(Java Doc)
abstract public Message getMessage(int msgnum) throws MessagingException(Code)(Java Doc)
abstract public int getMessageCount() throws MessagingException(Code)(Java Doc)
public synchronized Message[] getMessages(int start, int end) throws MessagingException(Code)(Java Doc)
public synchronized Message[] getMessages(int[] msgnums) throws MessagingException(Code)(Java Doc)
public synchronized Message[] getMessages() throws MessagingException(Code)(Java Doc)
public int getMode()(Code)(Java Doc)
abstract public String getName()(Code)(Java Doc)
public synchronized int getNewMessageCount() throws MessagingException(Code)(Java Doc)
abstract public Folder getParent() throws MessagingException(Code)(Java Doc)
abstract public Flags getPermanentFlags()(Code)(Java Doc)
abstract public char getSeparator() throws MessagingException(Code)(Java Doc)
public Store getStore()(Code)(Java Doc)
abstract public int getType() throws MessagingException(Code)(Java Doc)
public URLName getURLName() throws MessagingException(Code)(Java Doc)
public synchronized int getUnreadMessageCount() throws MessagingException(Code)(Java Doc)
abstract public boolean hasNewMessages() throws MessagingException(Code)(Java Doc)
abstract public boolean isOpen()(Code)(Java Doc)
public boolean isSubscribed()(Code)(Java Doc)
abstract public Folder[] list(String pattern) throws MessagingException(Code)(Java Doc)
public Folder[] list() throws MessagingException(Code)(Java Doc)
public Folder[] listSubscribed(String pattern) throws MessagingException(Code)(Java Doc)
public Folder[] listSubscribed() throws MessagingException(Code)(Java Doc)
protected void notifyConnectionListeners(int type)(Code)(Java Doc)
protected void notifyFolderListeners(int type)(Code)(Java Doc)
protected void notifyFolderRenamedListeners(Folder folder)(Code)(Java Doc)
protected void notifyMessageAddedListeners(Message[] msgs)(Code)(Java Doc)
protected void notifyMessageChangedListeners(int type, Message msg)(Code)(Java Doc)
protected void notifyMessageRemovedListeners(boolean removed, Message[] msgs)(Code)(Java Doc)
abstract public void open(int mode) throws MessagingException(Code)(Java Doc)
public synchronized void removeConnectionListener(ConnectionListener l)(Code)(Java Doc)
public synchronized void removeFolderListener(FolderListener l)(Code)(Java Doc)
public synchronized void removeMessageChangedListener(MessageChangedListener l)(Code)(Java Doc)
public synchronized void removeMessageCountListener(MessageCountListener l)(Code)(Java Doc)
abstract public boolean renameTo(Folder f) throws MessagingException(Code)(Java Doc)
public Message[] search(SearchTerm term) throws MessagingException(Code)(Java Doc)
public Message[] search(SearchTerm term, Message[] msgs) throws MessagingException(Code)(Java Doc)
public synchronized void setFlags(Message[] msgs, Flags flag, boolean value) throws MessagingException(Code)(Java Doc)
public synchronized void setFlags(int start, int end, Flags flag, boolean value) throws MessagingException(Code)(Java Doc)
public synchronized void setFlags(int[] msgnums, Flags flag, boolean value) throws MessagingException(Code)(Java Doc)
public void setSubscribed(boolean subscribe) throws MessagingException(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.