com.extrememessaging.ResponseMaster
Class MailboxConnectionInfo

java.lang.Object
  extended by com.extrememessaging.ResponseMaster.MailboxConnectionInfo

public class MailboxConnectionInfo
extends java.lang.Object

Encapsulates the settings required to connection to a mailbox: protocol, username, ...


Constructor Summary
MailboxConnectionInfo()
           
 
Method Summary
 void ClearSubfolder()
          For internal use only.
 javax.mail.Folder GetFolder()
          Get the folder specified by the connection info
 boolean getInboxHoldsFolders()
          On some IMAP mailservers, subfolders are children of the INBOX, and on some, they are siblings of the INBOX.
 void ReadFromNode(org.w3c.dom.Element oMailboxElement, java.lang.String sConfigFileName)
          Initialize the mailbox connection info
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MailboxConnectionInfo

public MailboxConnectionInfo()
Method Detail

getInboxHoldsFolders

public boolean getInboxHoldsFolders()
On some IMAP mailservers, subfolders are children of the INBOX, and on some, they are siblings of the INBOX. This returns true if they are children. Note: this value is only valid for IMAP and maildir mailboxes, and only after getFolder is called.


ClearSubfolder

public void ClearSubfolder()
For internal use only.


ReadFromNode

public void ReadFromNode(org.w3c.dom.Element oMailboxElement,
                         java.lang.String sConfigFileName)
                  throws ResponseMasterException
Initialize the mailbox connection info

Parameters:
oMailboxElement - The xml dom node to read the mailbox config from
sConfigFileName - The config file that the node is from...this is used to load relative paths.
Throws:
Throws - a ResponseMasterException if there is a problem
ResponseMasterException

GetFolder

public javax.mail.Folder GetFolder()
                            throws javax.mail.MessagingException
Get the folder specified by the connection info

Throws:
javax.mail.MessagingException