com.extrememessaging.ResponseMaster

Class MailboxConnectionInfo

java.lang.Object

com.extrememessaging.ResponseMaster.MailboxConnectionInfo

public class MailboxConnectionInfo
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
MailboxConnectionInfo()

Method Summary

Modifier and Type	Method and Description
void	ClearSubfolder() For internal use only.
jakarta.mail.Folder	GetFolder()
boolean	getInboxHoldsFolders() On some IMAP mailservers, subfolders are children of the INBOX, and on some, they are siblings of the INBOX.
boolean	OAuthTokenIsExpired() Is the OAuth token expired.
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. Note: this value is only valid for IMAP and maildir mailboxes, and only after getFolder is called.

Returns:

true if subfolders are children of the INBOX, false if they are siblings

OAuthTokenIsExpired

public boolean OAuthTokenIsExpired()

Is the OAuth token expired. Note: returns false if non-oauth

Returns:

True if the OAuth token is expired. False if it is valid or there is no token

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:

ResponseMasterException - if there is a problem

GetFolder

public jakarta.mail.Folder GetFolder()
                              throws jakarta.mail.MessagingException,
                                     ResponseMasterException

Returns:

A Folder object as specified by the connection info

Throws:

jakarta.mail.MessagingException - if there is a jakarta mail exception opening the folder

ResponseMasterException - if there is a non-jakarta mail problem opening the folder