Java Doc for IImapServer.java in  » Mail-Clients » columba-1.4 » org » columba » mail » imap » 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 » Mail Clients » columba 1.4 » org.columba.mail.imap 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.columba.mail.imap.IImapServer

All known Subclasses:   org.columba.mail.imap.IMAPServer,  org.columba.mail.imap.TestServer,
IImapServer
public interface IImapServer (Code)




Method Summary
public  voidalertMessage(String arg0)
    
public  Integerappend(InputStream messageSource, IMAPFlags flags, IMAPFolder folder)
     Append message to mailbox.
public  Integerappend(InputStream messageSource, IMAPFolder folder)
     Append message to mailbox.
public  ListcheckSupportedAuthenticationMethods()
    
public  voidconnectionClosed(String arg0, String arg1)
    
public  Integer[]copy(IMAPFolder destFolder, Object[] uids, IMAPFolder folder)
     Copy a set of messages to another mailbox on the same IMAP server.

We copy messages in pieces of 100 headers.

public  voidcreateMailbox(String mailboxName, IMAPFolder folder)
     Create new mailbox.
public  voiddeleteFolder(String path)
     Delete mailbox.
public  voidensureSelectedState(IMAPFolder folder)
     Check if mailbox is already selected.
public  voidexistsChanged(String arg0, int arg1)
    
public  voidexpunge(IMAPFolder folder)
     Expunge folder.
public  IMAPFlags[]fetchFlagsListStartFrom(int startIdx, IMAPFolder folder)
     Fetch list of flags and parse it.
public  IMAPFlags[]fetchFlagsListStartFrom2(int startIdx, IMAPFolder folder)
     Fetch list of flags and parse it.
public  voidfetchHeaderList(IHeaderList headerList, List list, IMAPFolder folder)
     Fetch list of headers and parse them.

We fetch headers in pieces of 100 headers.

public  NamespaceCollectionfetchNamespaces()
    
public  ListInfo[]fetchSubscribedFolders()
    
public  intfetchUid(SequenceSet set, IMAPFolder folder)
     Fetch the uid for the index.
public  Integer[]fetchUids(SequenceSet set, IMAPFolder folder)
     Fetch list of UIDs.
public  voidflagsChanged(String arg0, IMAPFlags arg1)
    
public  HeadergetAllHeaders(Object uid, IMAPFolder folder)
     Get complete headers.
public  StringgetDelimiter()
    
public  HeadergetHeaders(Object uid, String[] keys, IMAPFolder folder)
     Get MimePart .
public  intgetIndex(Integer uid, IMAPFolder folder)
    
public  ImapItemgetItem()
    
public  intgetLargestRemoteUid(IMAPFolder folder)
    
public  MailboxInfogetMessageFolderInfo(IMAPFolder folder)
    
public  InputStreamgetMessageSourceStream(Object uid, IMAPFolder folder)
     Get complete message source.
public  InputStreamgetMimePartBodyStream(Object uid, Integer[] address, IMAPFolder folder)
     Get MimePart .
public  InputStreamgetMimePartSourceStream(Object uid, Integer[] address, IMAPFolder folder)
     Get MimePart .
public  MimeTreegetMimeTree(Object uid, IMAPFolder folder)
     Get MimeTree .
public  MailboxStatusgetStatus(IMAPFolder folder)
    
public  booleanisSelected(IMAPFolder folder)
    
public  booleanisSupported(String command)
    
public  ListInfo[]list(String reference, String pattern)
     List available Mailboxes.
public  voidlogout()
     Logout cleanly.
public  voidmarkMessage(Object[] uids, int variant, IMAPFolder folder)
     Mark message as specified by variant.

See MarkMessageCommand for a list of variants.

We mark messages in pieces of 100 headers.

public  voidparseError(String arg0)
    
public  voidrecentChanged(String arg0, int arg1)
    
public  voidrenameFolder(String oldMailboxName, String newMailboxName)
     Rename mailbox.
public  Listsearch(Object[] uids, IFilterRule filterRule, IMAPFolder folder)
     Search messages.
public  Integer[]search(SearchKey key, IMAPFolder folder)
    
public  Listsearch(IFilterRule filterRule, IMAPFolder folder)
    
public  voidsetExistsChangedAction(IExistsChangedAction existsChangedAction)
    
public  voidsetFirstLoginAction(IFirstLoginAction action)
    
public  voidsetFlags(Object[] uids, IMAPFlags flags, IMAPFolder folder)
    
public  voidsetObservable(IStatusObservable observable)
    
public  voidsetUpdateFlagAction(IUpdateFlagAction updateFlagAction)
    
public  voidsubscribeFolder(String mailboxName)
     Subscribe to mailbox.
public  voidunsubscribeFolder(String mailboxName)
     Unsubscribe to mailbox.
public  voidupdate(Observable o, Object arg)
    
public  voidwarningMessage(String arg0)
    



Method Detail
alertMessage
public void alertMessage(String arg0)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.alertMessage(java.lang.String)



append
public Integer append(InputStream messageSource, IMAPFlags flags, IMAPFolder folder) throws Exception(Code)
Append message to mailbox.
Parameters:
  messageSource - message source
Parameters:
  folder - name of mailbox
throws:
  Exception -



append
public Integer append(InputStream messageSource, IMAPFolder folder) throws Exception(Code)
Append message to mailbox.
Parameters:
  messageSource - message source
Parameters:
  folder - name of mailbox
throws:
  Exception -



checkSupportedAuthenticationMethods
public List checkSupportedAuthenticationMethods() throws IOException(Code)



connectionClosed
public void connectionClosed(String arg0, String arg1)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.connectionClosed(java.lang.Stringjava.lang.String)



copy
public Integer[] copy(IMAPFolder destFolder, Object[] uids, IMAPFolder folder) throws Exception(Code)
Copy a set of messages to another mailbox on the same IMAP server.

We copy messages in pieces of 100 headers. This means we tokenize the list in sublists of the size of 100. Then we execute the command and process those 100 results.
Parameters:
  destFolder - destination mailbox
Parameters:
  uids - UIDs of messages -> this array will get sorted!
Parameters:
  path - source mailbox
throws:
  Exception -




createMailbox
public void createMailbox(String mailboxName, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Create new mailbox.
Parameters:
  mailboxName - name of new mailbox
throws:
  Exception -



deleteFolder
public void deleteFolder(String path) throws Exception(Code)
Delete mailbox.
Parameters:
  mailboxName - name of mailbox
throws:
  Exception -



ensureSelectedState
public void ensureSelectedState(IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Check if mailbox is already selected.

If its not selected -> select it.
Parameters:
  path - mailbox path
throws:
  Exception -




existsChanged
public void existsChanged(String arg0, int arg1)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.existsChanged(java.lang.Stringint)



expunge
public void expunge(IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Expunge folder.

Delete every message mark as expunged.
Parameters:
  folder - name of mailbox
throws:
  Exception -




fetchFlagsListStartFrom
public IMAPFlags[] fetchFlagsListStartFrom(int startIdx, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Fetch list of flags and parse it.
Parameters:
  folder - mailbox name list of flags
throws:
  Exception -



fetchFlagsListStartFrom2
public IMAPFlags[] fetchFlagsListStartFrom2(int startIdx, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Fetch list of flags and parse it.
Parameters:
  folder - mailbox name list of flags
throws:
  Exception -



fetchHeaderList
public void fetchHeaderList(IHeaderList headerList, List list, IMAPFolder folder) throws Exception(Code)
Fetch list of headers and parse them.

We fetch headers in pieces of 100 headers. This means we tokenize the list in sublists of the size of 100. Then we execute the command and process those 100 results.
Parameters:
  headerList - headerlist to add new headers
Parameters:
  list - list of UIDs to download
Parameters:
  path - mailbox name
throws:
  Exception -




fetchNamespaces
public NamespaceCollection fetchNamespaces() throws IOException, IMAPException, CommandCancelledException(Code)



fetchSubscribedFolders
public ListInfo[] fetchSubscribedFolders() throws IOException, IMAPException, CommandCancelledException(Code)



fetchUid
public int fetchUid(SequenceSet set, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Fetch the uid for the index.
Parameters:
  index - of the message
Parameters:
  folder - the IMAP mailbox uid of the message
throws:
  IOException -
throws:
  IMAPException -
throws:
  CommandCancelledException -



fetchUids
public Integer[] fetchUids(SequenceSet set, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Fetch list of UIDs.
Parameters:
  folder - mailbox name list of flags
throws:
  Exception -



flagsChanged
public void flagsChanged(String arg0, IMAPFlags arg1)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.flagsChanged(java.lang.Stringorg.columba.ristretto.imap.IMAPFlags)



getAllHeaders
public Header getAllHeaders(Object uid, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Get complete headers.
Parameters:
  uid - message uid
Parameters:
  folder - mailbox path
throws:
  Exception -
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -



getDelimiter
public String getDelimiter() throws IOException, IMAPException, CommandCancelledException(Code)
Get mailbox path delimiter

example: "/" (uw-imap), or "." (cyrus) delimiter




getHeaders
public Header getHeaders(Object uid, String[] keys, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Get MimePart .
Parameters:
  uid - message UID
Parameters:
  address - address of MimePart in MimeTree
Parameters:
  folder - mailbox name mimepart
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -
throws:
  Exception -



getIndex
public int getIndex(Integer uid, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)



getItem
public ImapItem getItem()(Code)
Returns the item.



getLargestRemoteUid
public int getLargestRemoteUid(IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)



getMessageFolderInfo
public MailboxInfo getMessageFolderInfo(IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)

Parameters:
  folder -
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -



getMessageSourceStream
public InputStream getMessageSourceStream(Object uid, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Get complete message source.
Parameters:
  uid - message UID
Parameters:
  path - mailbox name message source
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -
throws:
  Exception -



getMimePartBodyStream
public InputStream getMimePartBodyStream(Object uid, Integer[] address, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Get MimePart .
Parameters:
  uid - message UID
Parameters:
  address - address of MimePart in MimeTree
Parameters:
  folder - mailbox name mimepart
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -
throws:
  Exception -



getMimePartSourceStream
public InputStream getMimePartSourceStream(Object uid, Integer[] address, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Get MimePart .
Parameters:
  uid - message UID
Parameters:
  address - address of MimePart in MimeTree
Parameters:
  folder - mailbox name mimepart
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -
throws:
  Exception -



getMimeTree
public MimeTree getMimeTree(Object uid, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Get MimeTree .
Parameters:
  uid - message UID
Parameters:
  folder - mailbox name mimetree
throws:
  Exception -



getStatus
public MailboxStatus getStatus(IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)



isSelected
public boolean isSelected(IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)

Parameters:
  imapPath -
throws:
  IOException -
throws:
  CommandCancelledException -
throws:
  IMAPException -



isSupported
public boolean isSupported(String command) throws IOException(Code)

Parameters:
  command -



list
public ListInfo[] list(String reference, String pattern) throws Exception(Code)
List available Mailboxes.
Parameters:
  reference -
Parameters:
  pattern -
throws:
  Exception -



logout
public void logout() throws Exception(Code)
Logout cleanly.
throws:
  Exception -



markMessage
public void markMessage(Object[] uids, int variant, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)
Mark message as specified by variant.

See MarkMessageCommand for a list of variants.

We mark messages in pieces of 100 headers. This means we tokenize the list in sublists of the size of 100. Then we execute the command and process those 100 results.
Parameters:
  uids - message UID
Parameters:
  variant - variant (read/flagged/expunged/etc.)
Parameters:
  folder - mailbox name
throws:
  Exception -




parseError
public void parseError(String arg0)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.parseError(java.lang.String)



recentChanged
public void recentChanged(String arg0, int arg1)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.recentChanged(java.lang.Stringint)



renameFolder
public void renameFolder(String oldMailboxName, String newMailboxName) throws IOException, IMAPException, CommandCancelledException(Code)
Rename mailbox.
Parameters:
  oldMailboxName - old mailbox name
Parameters:
  newMailboxName - new mailbox name
throws:
  Exception -



search
public List search(Object[] uids, IFilterRule filterRule, IMAPFolder folder) throws Exception(Code)
Search messages.
Parameters:
  uids - message UIDs
Parameters:
  filterRule - filter rules
Parameters:
  folder - mailbox name list of UIDs which match filter rules
throws:
  Exception -



search
public Integer[] search(SearchKey key, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)



search
public List search(IFilterRule filterRule, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)

Parameters:
  filterRule -
Parameters:
  folder -
throws:
  Exception -
throws:
  CommandCancelledException -
throws:
  IMAPException -
throws:
  IOException -



setExistsChangedAction
public void setExistsChangedAction(IExistsChangedAction existsChangedAction)(Code)

Parameters:
  existsChangedAction - The existsChangedAction to set.



setFirstLoginAction
public void setFirstLoginAction(IFirstLoginAction action)(Code)



setFlags
public void setFlags(Object[] uids, IMAPFlags flags, IMAPFolder folder) throws IOException, IMAPException, CommandCancelledException(Code)



setObservable
public void setObservable(IStatusObservable observable)(Code)

Parameters:
  observable - The observable to set.



setUpdateFlagAction
public void setUpdateFlagAction(IUpdateFlagAction updateFlagAction)(Code)

Parameters:
  updateFlagAction - The updateFlagAction to set.



subscribeFolder
public void subscribeFolder(String mailboxName) throws IOException, IMAPException, CommandCancelledException(Code)
Subscribe to mailbox.
Parameters:
  mailboxName - name of mailbox
throws:
  Exception -



unsubscribeFolder
public void unsubscribeFolder(String mailboxName) throws IOException, IMAPException, CommandCancelledException(Code)
Unsubscribe to mailbox.
Parameters:
  mailboxNamename - of mailbox
throws:
  Exception -



update
public void update(Observable o, Object arg)(Code)



warningMessage
public void warningMessage(String arg0)(Code)

See Also:   org.columba.ristretto.imap.IMAPListener.warningMessage(java.lang.String)



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