com.knowgate.hipermail

Class DBFolder

java.lang.Object

javax.mail.Folder

com.knowgate.hipermail.DBFolder

public class DBFolder
extends javax.mail.Folder

A subclass of javax.mail.Folder providing storage for MimeMessages at database LONGVARBINARY columns and MBOX files.

Folders are also a subclass of com.knowgate.hipergate.Category
Category behaviour is obtained by delegation to a private Category instance.
For each DBFolder there is a corresponding row at k_categories database table.

Version:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static short	ClassId
static int	MODE_BLOB
static int	MODE_MBOX

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, READ_ONLY, READ_WRITE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	appendMessage(javax.mail.internet.MimeMessage oMsg)
void	appendMessages(javax.mail.Message[] msgs) Append messages to this DBFolder
void	close(boolean expunge) Close this folder
java.lang.String	copyMessage(DBMimeMessage oSrcMsg) Copy a DBMimeMessage from another DBFolder to this DBFolder
boolean	create(int type) This method is not implemented and will always raise UnsupportedOperationException
boolean	create(java.lang.String sFolderName) Create DBFolder with given name under current user mailroot Category
boolean	delete(boolean recurse) Wipe all messages and delete this folder
boolean	exists()
javax.mail.Message[]	expunge() Expunge deleted messages This method removes from the database and the MBOX file those messages flagged as deleted at k_mime_msgs table
Category	getCategory() Get instance of com.knowgate.hipergate.Category object
java.lang.String	getCategoryGuid() Get Category GUID Each folder has a Global Unique Identifier which is stored at column gu_category of table k_categories
java.lang.String	getDirectoryPath() Get path to directory containing files belonging to this folder
java.io.File	getFile() Get MBOX file that holds messages for this DBFolder
java.lang.String	getFilePath() Get full path to MBOX file containing mime messages
javax.mail.Folder	getFolder(java.lang.String name) Get folder by name or GUID
java.lang.String	getFullName() Get category subpath to directory holding MBOX files for this folder The category path is composed by concatenating the names of all the parent folders separated by a slash.
javax.mail.Message	getMessage(int msgnum)
DBMimeMessage	getMessageByGuid(java.lang.String sMsgGuid)
DBMimeMessage	getMessageByID(java.lang.String sMsgId)
int	getMessageCount()
java.util.Properties	getMessageHeaders(java.lang.String sMsgId) Get message GUID, Id, Number, Subject, From and Reply-To from k_mime_msgs table This method is mainly used for testing whether or not a message is already present at current folder.
java.lang.String	getName() Get column nm_category from table k_categories for this folder
javax.mail.Folder	getParent()
javax.mail.Flags	getPermanentFlags()
char	getSeparator()
int	getType()
javax.mail.URLName	getURLName()
boolean	hasNewMessages() This method is not implemented and will always raise UnsupportedOperationException
int	importMbox(java.lang.String sMboxFilePath)
boolean	isOpen()
DBKeySet	keySet() Get set of identifiers for messages at this folder Set entries are the mime identifiers for each message
javax.mail.Folder[]	list(java.lang.String pattern)
java.lang.String[]	listMessages() Get a list of all messages in this folder which are not deleted
void	moveMessage(DBMimeMessage oSrcMsg) Move a DBMimeMessage from another DBFolder to this DBFolder
void	open(int mode) Open this DBFolder
void	reindexMbox() Delete very message from th eindex and rebuild it by reading the default MBOX file for this folder
void	reindexMbox(java.lang.String sMboxFilePath) Delete every message from the index and rebuild it by re-reading the specified MBOX file
boolean	renameTo(javax.mail.Folder f)
void	wipe() Delete all messages from this folder and clear MBOX file

Methods inherited from class javax.mail.Folder

addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, copyMessages, fetch, getDeletedMessageCount, getMessages, getMessages, getMessages, getMode, getNewMessageCount, getStore, getUnreadMessageCount, isSubscribed, list, listSubscribed, listSubscribed, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MODE_MBOX

public static final int MODE_MBOX

See Also:

Constant Field Values

MODE_BLOB

public static final int MODE_BLOB

See Also:

Constant Field Values

ClassId

public static final short ClassId

See Also:

Constant Field Values

Method Detail

getCategory

public Category getCategory()

Get instance of com.knowgate.hipergate.Category object

getCategoryGuid

public java.lang.String getCategoryGuid()

Get Category GUID

Each folder has a Global Unique Identifier which is stored at column gu_category of table k_categories

Returns:

String Category GUID or null if category is not set

keySet

public DBKeySet keySet()
                throws java.sql.SQLException

Get set of identifiers for messages at this folder

Set entries are the mime identifiers for each message

Returns:

DBKeySet

Throws:

java.sql.SQLException

appendMessages

public void appendMessages(javax.mail.Message[] msgs)
                    throws javax.mail.MessagingException,
                           java.lang.ArrayIndexOutOfBoundsException

Append messages to this DBFolder

Specified by:

appendMessages in class javax.mail.Folder

Parameters:

msgs - Array of mime messages to be appended

Throws:

javax.mail.MessagingException

java.lang.ArrayIndexOutOfBoundsException

copyMessage

public java.lang.String copyMessage(DBMimeMessage oSrcMsg)
                             throws javax.mail.MessagingException

Copy a DBMimeMessage from another DBFolder to this DBFolder

Parameters:

oSrcMsg - Source message.

Returns:

GUID of new message

Throws:

javax.mail.MessagingException

moveMessage

public void moveMessage(DBMimeMessage oSrcMsg)
                 throws javax.mail.MessagingException

Move a DBMimeMessage from another DBFolder to this DBFolder

Parameters:

oSrcMsg - Source message

Throws:

javax.mail.MessagingException

create

public boolean create(int type)
               throws javax.mail.MessagingException

This method is not implemented and will always raise UnsupportedOperationException

Specified by:

create in class javax.mail.Folder

Throws:

java.lang.UnsupportedOperationException

javax.mail.MessagingException

create

public boolean create(java.lang.String sFolderName)
               throws javax.mail.MessagingException

Create DBFolder with given name under current user mailroot Category

Parameters:

sFolderName - Folder Name

Returns:

true

Throws:

javax.mail.MessagingException

open

public void open(int mode)
          throws javax.mail.MessagingException

Open this DBFolder

Specified by:

open in class javax.mail.Folder

Parameters:

mode - {READ_ONLY|READ_WRITE}

Throws:

javax.mail.MessagingException

close

public void close(boolean expunge)
           throws javax.mail.MessagingException

Close this folder

Specified by:

close in class javax.mail.Folder

Parameters:

expunge -

Throws:

javax.mail.MessagingException

delete

public boolean delete(boolean recurse)
               throws javax.mail.MessagingException

Wipe all messages and delete this folder

Specified by:

delete in class javax.mail.Folder

Parameters:

recurse - boolean

Returns:

boolean

Throws:

javax.mail.MessagingException

getFolder

public javax.mail.Folder getFolder(java.lang.String name)
                            throws javax.mail.MessagingException

Get folder by name or GUID

Specified by:

getFolder in class javax.mail.Folder

Parameters:

name - String Folder name or GUID

Returns:

Folder

Throws:

javax.mail.MessagingException

hasNewMessages

public boolean hasNewMessages()
                       throws javax.mail.MessagingException

This method is not implemented and will always raise UnsupportedOperationException

Specified by:

hasNewMessages in class javax.mail.Folder

Throws:

java.lang.UnsupportedOperationException

javax.mail.MessagingException

renameTo

public boolean renameTo(javax.mail.Folder f)
                 throws javax.mail.MessagingException,
                        javax.mail.StoreClosedException,
                        java.lang.NullPointerException

Specified by:

renameTo in class javax.mail.Folder

Throws:

javax.mail.MessagingException

javax.mail.StoreClosedException

java.lang.NullPointerException

exists

public boolean exists()
               throws javax.mail.MessagingException,
                      javax.mail.StoreClosedException

Specified by:

exists in class javax.mail.Folder

Throws:

javax.mail.MessagingException

javax.mail.StoreClosedException

expunge

public javax.mail.Message[] expunge()
                             throws javax.mail.MessagingException

Expunge deleted messages

This method removes from the database and the MBOX file those messages flagged as deleted at k_mime_msgs table

Specified by:

expunge in class javax.mail.Folder

Returns:

null

Throws:

javax.mail.MessagingException

wipe

public void wipe()
          throws javax.mail.MessagingException

Delete all messages from this folder and clear MBOX file

Throws:

javax.mail.MessagingException

getFullName

public java.lang.String getFullName()

Get category subpath to directory holding MBOX files for this folder

The category path is composed by concatenating the names of all the parent folders separated by a slash. The name of a folder is stored at column nm_category of table k_categories

Specified by:

getFullName in class javax.mail.Folder

Returns:

String

getDirectoryPath

public java.lang.String getDirectoryPath()

Get path to directory containing files belonging to this folder

Returns:

String

getFilePath

public java.lang.String getFilePath()
                             throws java.lang.NullPointerException

Get full path to MBOX file containing mime messages

Returns:

String

Throws:

java.lang.NullPointerException

getFile

public java.io.File getFile()

Get MBOX file that holds messages for this DBFolder

Returns:

java.io.File object representing MBOX file.

Throws:

java.lang.NullPointerException

getName

public java.lang.String getName()

Get column nm_category from table k_categories for this folder

Specified by:

getName in class javax.mail.Folder

Returns:

String

getURLName

public javax.mail.URLName getURLName()
                              throws javax.mail.MessagingException,
                                     javax.mail.StoreClosedException

Overrides:

getURLName in class javax.mail.Folder

Throws:

javax.mail.MessagingException

javax.mail.StoreClosedException

appendMessage

public java.lang.String appendMessage(javax.mail.internet.MimeMessage oMsg)
                               throws javax.mail.FolderClosedException,
                                      javax.mail.StoreClosedException,
                                      javax.mail.MessagingException,
                                      java.lang.ArrayIndexOutOfBoundsException,
                                      java.lang.NullPointerException

Parameters:

oMsg - MimeMessage

Returns:

String

Throws:

javax.mail.FolderClosedException

javax.mail.StoreClosedException

javax.mail.MessagingException

java.lang.ArrayIndexOutOfBoundsException

java.lang.NullPointerException - if oMsg is null

getMessage

public javax.mail.Message getMessage(int msgnum)
                              throws javax.mail.MessagingException

Specified by:

getMessage in class javax.mail.Folder

Throws:

javax.mail.MessagingException

getMessageByGuid

public DBMimeMessage getMessageByGuid(java.lang.String sMsgGuid)
                               throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getMessageByID

public DBMimeMessage getMessageByID(java.lang.String sMsgId)
                             throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getMessageCount

public int getMessageCount()
                    throws javax.mail.FolderClosedException,
                           javax.mail.MessagingException

Specified by:

getMessageCount in class javax.mail.Folder

Throws:

javax.mail.FolderClosedException

javax.mail.MessagingException

getParent

public javax.mail.Folder getParent()
                            throws javax.mail.MessagingException

Specified by:

getParent in class javax.mail.Folder

Throws:

javax.mail.MessagingException

getPermanentFlags

public javax.mail.Flags getPermanentFlags()

Specified by:

getPermanentFlags in class javax.mail.Folder

getSeparator

public char getSeparator()
                  throws javax.mail.MessagingException

Specified by:

getSeparator in class javax.mail.Folder

Throws:

javax.mail.MessagingException

list

public javax.mail.Folder[] list(java.lang.String pattern)
                         throws javax.mail.MessagingException

Specified by:

list in class javax.mail.Folder

Throws:

javax.mail.MessagingException

listMessages

public java.lang.String[] listMessages()
                                throws java.sql.SQLException,
                                       javax.mail.MessagingException

Get a list of all messages in this folder which are not deleted

Returns:

An array of strings with format <msg> <num>[1..n]</num> <id>message unique identifier</id> <len>message length in bytes</len> <type>message content-type</type> <disposition>message content-disposition</disposition> <priority>X-Priority header</priority> <spam>X-Spam-Flag header</spam> <subject><![CDATA[message subject]]></subject> <sent>yyy-mm-dd hh:mi:ss</sent> <received>yyy-mm-dd hh:mi:ss</received> <from><![CDATA[personal name of sender]]></from> <to><![CDATA[personal name or e-mail of receiver]]></to> <size>integer size in kilobytes</size> <err>error description (if any)</err> </msg>

Throws:

java.sql.SQLException

javax.mail.MessagingException

Since:

4.0

getType

public int getType()
            throws javax.mail.MessagingException

Specified by:

getType in class javax.mail.Folder

Throws:

javax.mail.MessagingException

isOpen

public boolean isOpen()

Specified by:

isOpen in class javax.mail.Folder

getMessageHeaders

public java.util.Properties getMessageHeaders(java.lang.String sMsgId)
                                       throws javax.mail.FolderClosedException,
                                              java.sql.SQLException

Get message GUID, Id, Number, Subject, From and Reply-To from k_mime_msgs table

This method is mainly used for testing whether or not a message is already present at current folder.

Parameters:

sMsgId - String GUID or Id of message to be retrieved

Returns:

Properties {gu_mimemsg, id_message, pg_message, tx_subject, tx_email_from, tx_email_reply, nm_from } or null if no message with such sMsgId was found referenced at k_mime_msgs for current folder

Throws:

javax.mail.FolderClosedException

java.sql.SQLException

importMbox

public int importMbox(java.lang.String sMboxFilePath)
               throws java.io.FileNotFoundException,
                      java.io.IOException,
                      javax.mail.MessagingException

Throws:

java.io.FileNotFoundException

java.io.IOException

javax.mail.MessagingException

reindexMbox

public void reindexMbox(java.lang.String sMboxFilePath)
                 throws java.io.FileNotFoundException,
                        java.io.IOException,
                        javax.mail.MessagingException,
                        java.sql.SQLException

Delete every message from the index and rebuild it by re-reading the specified MBOX file

Parameters:

sMboxFilePath - String Full path to MBOX file

Throws:

java.io.FileNotFoundException

java.io.IOException

javax.mail.MessagingException

java.sql.SQLException

reindexMbox

public void reindexMbox()
                 throws java.io.FileNotFoundException,
                        java.io.IOException,
                        javax.mail.MessagingException,
                        java.sql.SQLException

Delete very message from th eindex and rebuild it by reading the default MBOX file for this folder

Throws:

java.io.FileNotFoundException

java.io.IOException

javax.mail.MessagingException

java.sql.SQLException