nsIMsgFolder Interface Reference

import "nsIMsgFolder.idl";

Inheritance diagram for nsIMsgFolder:

Inheritance graph
[legend]
Collaboration diagram for nsIMsgFolder:

Collaboration graph
[legend]

List of all members.

Public Member Functions

nsISimpleEnumerator getMessages (in nsIMsgWindow aMsgWindow)
void startFolderLoading ()
void endFolderLoading ()
void updateFolder (in nsIMsgWindow aWindow)
nsIMsgFilterList getFilterList (in nsIMsgWindow msgWindow)
 function to get the filter list on folder's server (or in the case of news, the filter list for this newsgroup)'
void setFilterList (in nsIMsgFilterList filterList)
void ForceDBClosed ()
void Delete ()
void deleteSubFolders (in nsIArray folders, in nsIMsgWindow msgWindow)
void propagateDelete (in nsIMsgFolder folder, in boolean deleteStorage, in nsIMsgWindow msgWindow)
void recursiveDelete (in boolean deleteStorage, in nsIMsgWindow msgWindow)
void createSubfolder (in AString folderName, in nsIMsgWindow msgWindow)
nsIMsgFolder addSubfolder (in AString folderName)
void createStorageIfMissing (in nsIUrlListener urlListener)
void compact (in nsIUrlListener aListener, in nsIMsgWindow aMsgWindow)
void compactAll (in nsIUrlListener aListener, in nsIMsgWindow aMsgWindow, in nsISupportsArray aFolderArray, in boolean aCompactOfflineAlso, in nsISupportsArray aOfflineFolderArray)
void compactAllOfflineStores (in nsIMsgWindow aMsgWindow, in nsISupportsArray aOfflineFolderArray)
void emptyTrash (in nsIMsgWindow aMsgWindow, in nsIUrlListener aListener)
void rename (in AString name, in nsIMsgWindow msgWindow)
 change the name of the folder
void renameSubFolders (in nsIMsgWindow msgWindow, in nsIMsgFolder oldFolder)
AString generateUniqueSubfolderName (in AString prefix, in nsIMsgFolder otherFolder)
void updateSummaryTotals (in boolean force)
void summaryChanged ()
long getNumUnread (in boolean deep)
 get the total number of unread messages in this folder, or in all subfolders
long getTotalMessages (in boolean deep)
 get the total number of messages in this folder, or in all subfolders
void clearNewMessages ()
 clear new status flag of all of the new messages
void clearRequiresCleanup ()
void setFlag (in unsigned long flag)
 Sets a flag on the folder.
void clearFlag (in unsigned long flag)
 Clears a flag on the folder.
boolean getFlag (in unsigned long flag)
 Determines if a flag is set on the folder or not.
void toggleFlag (in unsigned long flag)
 Toggles a flag on the folder.
void onFlagChange (in unsigned long flag)
 Called to notify the database and/or listeners of a change of flag.
void setPrefFlag ()
nsIMsgFolder getFolderWithFlags (in unsigned long flags)
 Gets the first folder that has the specified flags set.
nsIArray getFoldersWithFlags (in unsigned long flags)
 Gets the folders that have the specified flag set.
void listFoldersWithFlags (in unsigned long flags, in nsIMutableArray folders)
 Lists the folders that have the specified flag set.
void getExpansionArray (in nsISupportsArray expansionArray)
ACString getUriForMsg (in nsIMsgDBHdr msgHdr)
void deleteMessages (in nsIArray messages, in nsIMsgWindow msgWindow, in boolean deleteStorage, in boolean isMove, in nsIMsgCopyServiceListener listener, in boolean allowUndo)
void copyMessages (in nsIMsgFolder srcFolder, in nsIArray messages, in boolean isMove, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener, in boolean isFolder, in boolean allowUndo)
void copyFolder (in nsIMsgFolder srcFolder, in boolean isMoveFolder, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener)
void copyFileMessage (in nsIFile file, in nsIMsgDBHdr msgToReplace, in boolean isDraft, in unsigned long newMsgFlags, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener)
void acquireSemaphore (in nsISupports semHolder)
void releaseSemaphore (in nsISupports semHolder)
boolean testSemaphore (in nsISupports semHolder)
void getNewMessages (in nsIMsgWindow aWindow, in nsIUrlListener aListener)
void writeToFolderCache (in nsIMsgFolderCache folderCache, in boolean deep)
 write out summary data for this folder to the given folder cache (i.e.
long getNumNewMessages (in boolean deep)
 the number of new messages since this folder was last visited
void setNumNewMessages (in long numNewMessages)
ACString generateMessageURI (in nsMsgKey msgKey)
void addMessageDispositionState (in nsIMsgDBHdr aMessage, in nsMsgDispositionState aDispositionFlag)
void markMessagesRead (in nsIArray messages, in boolean markRead)
void markAllMessagesRead ()
void markMessagesFlagged (in nsIArray messages, in boolean markFlagged)
void markThreadRead (in nsIMsgThread thread)
void setLabelForMessages (in nsIArray messages, in nsMsgLabelValue label)
nsIMsgDatabase getMsgDatabase (in nsIMsgWindow msgWindow)
void setMsgDatabase (in nsIMsgDatabase msgDatabase)
nsIMsgDatabase getDBFolderInfoAndDB (out nsIDBFolderInfo folderInfo)
nsIMsgDBHdr GetMessageHeader (in nsMsgKey msgKey)
boolean shouldStoreMsgOffline (in nsMsgKey msgKey)
boolean hasMsgOffline (in nsMsgKey msgKey)
nsIInputStream getOfflineFileStream (in nsMsgKey msgKey, out PRUint32 offset, out PRUint32 size)
void DownloadMessagesForOffline (in nsIArray messages, in nsIMsgWindow window)
nsIMsgFolder getChildWithURI (in ACString uri, in boolean deep, in boolean caseInsensitive)
void downloadAllForOffline (in nsIUrlListener listener, in nsIMsgWindow window)
void enableNotifications (in long notificationType, in boolean enable, in boolean dbBatching)
boolean isCommandEnabled (in ACString command)
boolean matchOrChangeFilterDestination (in nsIMsgFolder folder, in boolean caseInsensitive)
boolean confirmFolderDeletionForFilter (in nsIMsgWindow msgWindow)
void alertFilterChanged (in nsIMsgWindow msgWindow)
void throwAlertMsg (in string msgName, in nsIMsgWindow msgWindow)
AString getStringWithFolderNameFromBundle (in string msgName)
void notifyCompactCompleted ()
long compareSortKeys (in nsIMsgFolder msgFolder)
void getSortKey (out octet_ptr key, out unsigned long length)
boolean callFilterPlugins (in nsIMsgWindow aMsgWindow)
ACString getStringProperty (in string propertyName)
void setStringProperty (in string propertyName, in ACString propertyValue)
boolean isAncestorOf (in nsIMsgFolder folder)
 Determines if this folder is an ancestor of the supplied folder.
boolean containsChildNamed (in AString name)
 Looks in immediate children of this folder for the given name.
nsIMsgFolder getChildNamed (in AString aName)
 Return the child folder which the specified name.
nsIMsgFolder findSubFolder (in ACString escapedSubFolderName)
 Finds the sub folder with the specified name.
void AddFolderListener (in nsIFolderListener listener)
void RemoveFolderListener (in nsIFolderListener listener)
void NotifyPropertyChanged (in nsIAtom property, in ACString oldValue, in ACString newValue)
void NotifyIntPropertyChanged (in nsIAtom property, in long oldValue, in long newValue)
void NotifyBoolPropertyChanged (in nsIAtom property, in boolean oldValue, in boolean newValue)
void NotifyPropertyFlagChanged (in nsIMsgDBHdr item, in nsIAtom property, in unsigned long oldValue, in unsigned long newValue)
void NotifyUnicharPropertyChanged (in nsIAtom property, in AString oldValue, in AString newValue)
void NotifyItemAdded (in nsISupports item)
void NotifyItemRemoved (in nsISupports item)
void NotifyFolderEvent (in nsIAtom event)
void ListDescendents (in nsISupportsArray descendents)
void Shutdown (in boolean shutdownChildren)
void setInVFEditSearchScope (in boolean aSearchThisFolder, in boolean aSetOnSubFolders)
void copyDataToOutputStreamForAppend (in nsIInputStream aIStream, in long aLength, in nsIOutputStream outputStream)
void copyDataDone ()
void setJunkScoreForMessages (in nsIArray aMessages, in ACString aJunkScore)
void applyRetentionSettings ()
boolean fetchMsgPreviewText ([array, size_is(aNumKeys)] in nsMsgKey aKeysToFetch, in unsigned long aNumKeys, in boolean aLocalOnly, in nsIUrlListener aUrlListener)
 Get the beginning of the message bodies for the passed in keys and store them in the msg hdr property "preview".
void addKeywordsToMessages (in nsIArray aMessages, in ACString aKeywords)
void removeKeywordsFromMessages (in nsIArray aMessages, in ACString aKeywords)
AUTF8String getMsgTextFromStream (in nsIMsgDBHdr aMsgHdr, in nsIInputStream aStream, in long aBytesToRead, in long aMaxOutputLen, in boolean aCompressQuotes)
 Extract the message preview text from aStream, storing it as a string property on aMsgHdr.

Public Attributes

const nsMsgBiffState nsMsgBiffState_NewMail = 0
const nsMsgBiffState nsMsgBiffState_NoMail = 1
const nsMsgBiffState nsMsgBiffState_Unknown = 2
readonly attribute AString prettiestName
readonly attribute ACString folderURL
 URL for this folder.
readonly attribute boolean showDeletedMessages
 should probably move to the server
readonly attribute
nsIMsgIncomingServer 
server
 this folder's parent server
readonly attribute boolean isServer
 is this folder the "phantom" server folder?
readonly attribute boolean canSubscribe
readonly attribute boolean canFileMessages
readonly attribute boolean noSelect
readonly attribute boolean imapShared
readonly attribute boolean canDeleteMessages
readonly attribute boolean canCreateSubfolders
 does this folder allow subfolders? for example, newsgroups cannot have subfolders, and the INBOX on some IMAP servers cannot have subfolders
readonly attribute boolean canRename
 can you change the name of this folder? for example, newsgroups and some special folders can't be renamed
readonly attribute boolean canCompact
readonly attribute nsIMsgFolder rootFolder
 the phantom server folder
attribute boolean hasNewMessages
 does this folder have new messages
readonly attribute nsIMsgDBHdr firstNewMessage
 return the first new message in the folder
readonly attribute unsigned long expungedBytes
readonly attribute boolean deletable
 can this folder be deleted? for example, special folders cannot be deleted
readonly attribute boolean displayRecipients
 should we be displaying recipients instead of the sender? for example, in the Sent folder, recipients are more relevant than the sender
readonly attribute boolean manyHeadersToDownload
 used to determine if it will take a long time to download all the headers in this folder - so that we can do folder notifications synchronously instead of asynchronously
readonly attribute boolean requiresCleanup
readonly attribute boolean knowsSearchNntpExtension
 this should go into a news-specific interface
readonly attribute boolean allowsPosting
 this should go into a news-specific interface
readonly attribute ACString relativePathName
attribute unsigned long sizeOnDisk
 size of this folder on disk (not including .msf file) for imap, it's the sum of the size of the messages
readonly attribute ACString username
readonly attribute ACString hostname
attribute unsigned long flags
 Direct access to the set/get all the flags at once.
readonly attribute boolean locked
attribute ACString charset
 the charset of this folder
attribute boolean charsetOverride
attribute unsigned long biffState
attribute boolean gettingNewMessages
 are we running a url as a result of the user clicking get msg?
attribute nsILocalFile filePath
 local path of this folder
readonly attribute ACString baseMessageURI
const nsMsgDispositionState nsMsgDispositionState_None = -1
const nsMsgDispositionState nsMsgDispositionState_Replied = 0
const nsMsgDispositionState nsMsgDispositionState_Forwarded = 1
readonly attribute boolean supportsOffline
readonly attribute nsIOutputStream offlineStoreOutputStream
readonly attribute nsIInputStream offlineStoreInputStream
const unsigned long allMessageCountNotifications = 0
 Turn notifications on/off for various notification types.
attribute nsIMsgRetentionSettings retentionSettings
attribute nsIMsgDownloadSettings downloadSettings
attribute long sortOrder
 used for order in the folder pane, folder pickers, etc.
readonly attribute nsIMsgFolder parentMsgFolder
attribute nsIDBFolderInfo dBTransferInfo
attribute nsMsgKey lastMessageLoaded
readonly attribute ACString URI
attribute AString name
attribute AString prettyName
readonly attribute AString abbreviatedName
attribute nsIMsgFolder parent
readonly attribute
nsISimpleEnumerator 
subFolders
 Returns an enumerator containing a list of nsIMsgFolder items that are subfolders of the instance this is called on.
readonly attribute boolean hasSubFolders
 Returns true if this folder has sub folders.
readonly attribute unsigned long numSubFolders
 Returns the number of sub folders that this folder has.
readonly attribute boolean inVFEditSearchScope
readonly attribute nsIMsgIdentity customIdentity


Member Function Documentation

nsISimpleEnumerator nsIMsgFolder::getMessages ( in nsIMsgWindow  aMsgWindow  ) 

void nsIMsgFolder::startFolderLoading (  ) 

void nsIMsgFolder::endFolderLoading (  ) 

void nsIMsgFolder::updateFolder ( in nsIMsgWindow  aWindow  ) 

nsIMsgFilterList nsIMsgFolder::getFilterList ( in nsIMsgWindow  msgWindow  ) 

function to get the filter list on folder's server (or in the case of news, the filter list for this newsgroup)'

void nsIMsgFolder::setFilterList ( in nsIMsgFilterList  filterList  ) 

void nsIMsgFolder::ForceDBClosed (  ) 

void nsIMsgFolder::Delete (  ) 

void nsIMsgFolder::deleteSubFolders ( in nsIArray  folders,
in nsIMsgWindow  msgWindow 
)

void nsIMsgFolder::propagateDelete ( in nsIMsgFolder  folder,
in boolean  deleteStorage,
in nsIMsgWindow  msgWindow 
)

void nsIMsgFolder::recursiveDelete ( in boolean  deleteStorage,
in nsIMsgWindow  msgWindow 
)

void nsIMsgFolder::createSubfolder ( in AString  folderName,
in nsIMsgWindow  msgWindow 
)

nsIMsgFolder nsIMsgFolder::addSubfolder ( in AString  folderName  ) 

void nsIMsgFolder::createStorageIfMissing ( in nsIUrlListener  urlListener  ) 

void nsIMsgFolder::compact ( in nsIUrlListener  aListener,
in nsIMsgWindow  aMsgWindow 
)

void nsIMsgFolder::compactAll ( in nsIUrlListener  aListener,
in nsIMsgWindow  aMsgWindow,
in nsISupportsArray  aFolderArray,
in boolean  aCompactOfflineAlso,
in nsISupportsArray  aOfflineFolderArray 
)

void nsIMsgFolder::compactAllOfflineStores ( in nsIMsgWindow  aMsgWindow,
in nsISupportsArray  aOfflineFolderArray 
)

void nsIMsgFolder::emptyTrash ( in nsIMsgWindow  aMsgWindow,
in nsIUrlListener  aListener 
)

void nsIMsgFolder::rename ( in AString  name,
in nsIMsgWindow  msgWindow 
)

change the name of the folder

Parameters:
name the new name of the folder

void nsIMsgFolder::renameSubFolders ( in nsIMsgWindow  msgWindow,
in nsIMsgFolder  oldFolder 
)

AString nsIMsgFolder::generateUniqueSubfolderName ( in AString  prefix,
in nsIMsgFolder  otherFolder 
)

void nsIMsgFolder::updateSummaryTotals ( in boolean  force  ) 

void nsIMsgFolder::summaryChanged (  ) 

long nsIMsgFolder::getNumUnread ( in boolean  deep  ) 

get the total number of unread messages in this folder, or in all subfolders

Parameters:
deep if true, descends into all subfolders and gets a grand total

long nsIMsgFolder::getTotalMessages ( in boolean  deep  ) 

get the total number of messages in this folder, or in all subfolders

Parameters:
deep if true, descends into all subfolders and gets a grand total

void nsIMsgFolder::clearNewMessages (  ) 

clear new status flag of all of the new messages

void nsIMsgFolder::clearRequiresCleanup (  ) 

void nsIMsgFolder::setFlag ( in unsigned long  flag  ) 

Sets a flag on the folder.

The known flags are defined in nsMsgFolderFlags.h.

Parameters:
flag The flag to set on the folder.

void nsIMsgFolder::clearFlag ( in unsigned long  flag  ) 

Clears a flag on the folder.

The known flags are defined in nsMsgFolderFlags.h.

Parameters:
flag The flag to clear on the folder.

boolean nsIMsgFolder::getFlag ( in unsigned long  flag  ) 

Determines if a flag is set on the folder or not.

The known flags are defined in nsMsgFolderFlags.h.

Parameters:
flag The flag to check on the folder.
Returns:
True if the flag exists.

void nsIMsgFolder::toggleFlag ( in unsigned long  flag  ) 

Toggles a flag on the folder.

The known flags are defined in nsMsgFolderFlags.h.

Parameters:
flag The flag to toggle

void nsIMsgFolder::onFlagChange ( in unsigned long  flag  ) 

Called to notify the database and/or listeners of a change of flag.

The known flags are defined in nsMsgFolderFlags.h

Note:
This doesn't need to be called for normal flag changes via the *Flag functions on this interface.
Parameters:
flag The flag that was changed.

void nsIMsgFolder::setPrefFlag (  ) 

nsIMsgFolder nsIMsgFolder::getFolderWithFlags ( in unsigned long  flags  ) 

Gets the first folder that has the specified flags set.

Parameters:
flags The flag(s) to check for.
Returns:
The folder or the first available child folder that has the specified flags set, or null if there are none.

nsIArray nsIMsgFolder::getFoldersWithFlags ( in unsigned long  flags  ) 

Gets the folders that have the specified flag set.

Parameters:
flags The flag(s) to check for.
Returns:
An array of folders that have the specified flags set. The array may have zero elements.

void nsIMsgFolder::listFoldersWithFlags ( in unsigned long  flags,
in nsIMutableArray  folders 
)

Lists the folders that have the specified flag set.

Parameters:
flags The flag(s) to check for.
folders The array in which to append the found folder(s).

void nsIMsgFolder::getExpansionArray ( in nsISupportsArray  expansionArray  ) 

ACString nsIMsgFolder::getUriForMsg ( in nsIMsgDBHdr  msgHdr  ) 

void nsIMsgFolder::deleteMessages ( in nsIArray  messages,
in nsIMsgWindow  msgWindow,
in boolean  deleteStorage,
in boolean  isMove,
in nsIMsgCopyServiceListener  listener,
in boolean  allowUndo 
)

void nsIMsgFolder::copyMessages ( in nsIMsgFolder  srcFolder,
in nsIArray  messages,
in boolean  isMove,
in nsIMsgWindow  msgWindow,
in nsIMsgCopyServiceListener  listener,
in boolean  isFolder,
in boolean  allowUndo 
)

void nsIMsgFolder::copyFolder ( in nsIMsgFolder  srcFolder,
in boolean  isMoveFolder,
in nsIMsgWindow  msgWindow,
in nsIMsgCopyServiceListener  listener 
)

void nsIMsgFolder::copyFileMessage ( in nsIFile  file,
in nsIMsgDBHdr  msgToReplace,
in boolean  isDraft,
in unsigned long  newMsgFlags,
in nsIMsgWindow  msgWindow,
in nsIMsgCopyServiceListener  listener 
)

void nsIMsgFolder::acquireSemaphore ( in nsISupports  semHolder  ) 

void nsIMsgFolder::releaseSemaphore ( in nsISupports  semHolder  ) 

boolean nsIMsgFolder::testSemaphore ( in nsISupports  semHolder  ) 

void nsIMsgFolder::getNewMessages ( in nsIMsgWindow  aWindow,
in nsIUrlListener  aListener 
)

void nsIMsgFolder::writeToFolderCache ( in nsIMsgFolderCache  folderCache,
in boolean  deep 
)

write out summary data for this folder to the given folder cache (i.e.

panacea.dat)

long nsIMsgFolder::getNumNewMessages ( in boolean  deep  ) 

the number of new messages since this folder was last visited

Parameters:
deep if true, descends into all subfolders and gets a grand total

void nsIMsgFolder::setNumNewMessages ( in long  numNewMessages  ) 

ACString nsIMsgFolder::generateMessageURI ( in nsMsgKey  msgKey  ) 

void nsIMsgFolder::addMessageDispositionState ( in nsIMsgDBHdr  aMessage,
in nsMsgDispositionState  aDispositionFlag 
)

void nsIMsgFolder::markMessagesRead ( in nsIArray  messages,
in boolean  markRead 
)

void nsIMsgFolder::markAllMessagesRead (  ) 

void nsIMsgFolder::markMessagesFlagged ( in nsIArray  messages,
in boolean  markFlagged 
)

void nsIMsgFolder::markThreadRead ( in nsIMsgThread  thread  ) 

void nsIMsgFolder::setLabelForMessages ( in nsIArray  messages,
in nsMsgLabelValue  label 
)

nsIMsgDatabase nsIMsgFolder::getMsgDatabase ( in nsIMsgWindow  msgWindow  ) 

void nsIMsgFolder::setMsgDatabase ( in nsIMsgDatabase  msgDatabase  ) 

nsIMsgDatabase nsIMsgFolder::getDBFolderInfoAndDB ( out nsIDBFolderInfo  folderInfo  ) 

nsIMsgDBHdr nsIMsgFolder::GetMessageHeader ( in nsMsgKey  msgKey  ) 

boolean nsIMsgFolder::shouldStoreMsgOffline ( in nsMsgKey  msgKey  ) 

boolean nsIMsgFolder::hasMsgOffline ( in nsMsgKey  msgKey  ) 

nsIInputStream nsIMsgFolder::getOfflineFileStream ( in nsMsgKey  msgKey,
out PRUint32  offset,
out PRUint32  size 
)

void nsIMsgFolder::DownloadMessagesForOffline ( in nsIArray  messages,
in nsIMsgWindow  window 
)

nsIMsgFolder nsIMsgFolder::getChildWithURI ( in ACString  uri,
in boolean  deep,
in boolean  caseInsensitive 
)

void nsIMsgFolder::downloadAllForOffline ( in nsIUrlListener  listener,
in nsIMsgWindow  window 
)

void nsIMsgFolder::enableNotifications ( in long  notificationType,
in boolean  enable,
in boolean  dbBatching 
)

boolean nsIMsgFolder::isCommandEnabled ( in ACString  command  ) 

boolean nsIMsgFolder::matchOrChangeFilterDestination ( in nsIMsgFolder  folder,
in boolean  caseInsensitive 
)

boolean nsIMsgFolder::confirmFolderDeletionForFilter ( in nsIMsgWindow  msgWindow  ) 

void nsIMsgFolder::alertFilterChanged ( in nsIMsgWindow  msgWindow  ) 

void nsIMsgFolder::throwAlertMsg ( in string  msgName,
in nsIMsgWindow  msgWindow 
)

AString nsIMsgFolder::getStringWithFolderNameFromBundle ( in string  msgName  ) 

void nsIMsgFolder::notifyCompactCompleted (  ) 

long nsIMsgFolder::compareSortKeys ( in nsIMsgFolder  msgFolder  ) 

void nsIMsgFolder::getSortKey ( out octet_ptr  key,
out unsigned long  length 
)

boolean nsIMsgFolder::callFilterPlugins ( in nsIMsgWindow  aMsgWindow  ) 

ACString nsIMsgFolder::getStringProperty ( in string  propertyName  ) 

void nsIMsgFolder::setStringProperty ( in string  propertyName,
in ACString  propertyValue 
)

boolean nsIMsgFolder::isAncestorOf ( in nsIMsgFolder  folder  ) 

Determines if this folder is an ancestor of the supplied folder.

Parameters:
folder The folder that may or may not be a descendent of this folder.

boolean nsIMsgFolder::containsChildNamed ( in AString  name  ) 

Looks in immediate children of this folder for the given name.

Parameters:
name the name of the target subfolder

nsIMsgFolder nsIMsgFolder::getChildNamed ( in AString  aName  ) 

Return the child folder which the specified name.

Parameters:
aName The name of the child folder to find
Returns:
The child folder
Exceptions:
NS_ERROR_FAILURE Thrown if the folder with aName does not exist

nsIMsgFolder nsIMsgFolder::findSubFolder ( in ACString  escapedSubFolderName  ) 

Finds the sub folder with the specified name.

Parameters:
escapedSubFolderName The name of the sub folder to find.
Note:
Even if the folder doesn't currently exist, a nsIMsgFolder may be returned.

void nsIMsgFolder::AddFolderListener ( in nsIFolderListener  listener  ) 

void nsIMsgFolder::RemoveFolderListener ( in nsIFolderListener  listener  ) 

void nsIMsgFolder::NotifyPropertyChanged ( in nsIAtom  property,
in ACString  oldValue,
in ACString  newValue 
)

void nsIMsgFolder::NotifyIntPropertyChanged ( in nsIAtom  property,
in long  oldValue,
in long  newValue 
)

void nsIMsgFolder::NotifyBoolPropertyChanged ( in nsIAtom  property,
in boolean  oldValue,
in boolean  newValue 
)

void nsIMsgFolder::NotifyPropertyFlagChanged ( in nsIMsgDBHdr  item,
in nsIAtom  property,
in unsigned long  oldValue,
in unsigned long  newValue 
)

void nsIMsgFolder::NotifyUnicharPropertyChanged ( in nsIAtom  property,
in AString  oldValue,
in AString  newValue 
)

void nsIMsgFolder::NotifyItemAdded ( in nsISupports  item  ) 

void nsIMsgFolder::NotifyItemRemoved ( in nsISupports  item  ) 

void nsIMsgFolder::NotifyFolderEvent ( in nsIAtom  event  ) 

void nsIMsgFolder::ListDescendents ( in nsISupportsArray  descendents  ) 

void nsIMsgFolder::Shutdown ( in boolean  shutdownChildren  ) 

void nsIMsgFolder::setInVFEditSearchScope ( in boolean  aSearchThisFolder,
in boolean  aSetOnSubFolders 
)

void nsIMsgFolder::copyDataToOutputStreamForAppend ( in nsIInputStream  aIStream,
in long  aLength,
in nsIOutputStream  outputStream 
)

void nsIMsgFolder::copyDataDone (  ) 

void nsIMsgFolder::setJunkScoreForMessages ( in nsIArray  aMessages,
in ACString  aJunkScore 
)

void nsIMsgFolder::applyRetentionSettings (  ) 

boolean nsIMsgFolder::fetchMsgPreviewText ( [array, size_is(aNumKeys)] in nsMsgKey  aKeysToFetch,
in unsigned long  aNumKeys,
in boolean  aLocalOnly,
in nsIUrlListener  aUrlListener 
)

Get the beginning of the message bodies for the passed in keys and store them in the msg hdr property "preview".

This is intended for new mail alerts, title tips on folders with new messages, and perhaps titletips/message preview in the thread pane.

Parameters:
aKeysToFetch keys of msgs to fetch
aNumKeys number of keys to fetch
aLocalOnly whether to fetch msgs from server (imap msgs might be in memory cache from junk filter)
aUrlListener url listener to notify if we run url to fetch msgs
Returns:
aAsyncResults if true, we ran a url to fetch one or more of msg bodies

void nsIMsgFolder::addKeywordsToMessages ( in nsIArray  aMessages,
in ACString  aKeywords 
)

void nsIMsgFolder::removeKeywordsFromMessages ( in nsIArray  aMessages,
in ACString  aKeywords 
)

AUTF8String nsIMsgFolder::getMsgTextFromStream ( in nsIMsgDBHdr  aMsgHdr,
in nsIInputStream  aStream,
in long  aBytesToRead,
in long  aMaxOutputLen,
in boolean  aCompressQuotes 
)

Extract the message preview text from aStream, storing it as a string property on aMsgHdr.

Parameters:
aMsgHdr 
aStream 
aBytesToRead number of bytes to read from the stream
aMaxOutputLen desired length of the converted message text. Used to control how many characters of msg text we want to store.
aCompressQuotes Replace quotes and citations with " ... " in the preview text


Member Data Documentation

readonly attribute AString nsIMsgFolder::prettiestName

readonly attribute ACString nsIMsgFolder::folderURL

URL for this folder.

should probably move to the server

this folder's parent server

readonly attribute boolean nsIMsgFolder::isServer

is this folder the "phantom" server folder?

readonly attribute boolean nsIMsgFolder::canSubscribe

readonly attribute boolean nsIMsgFolder::noSelect

readonly attribute boolean nsIMsgFolder::imapShared

does this folder allow subfolders? for example, newsgroups cannot have subfolders, and the INBOX on some IMAP servers cannot have subfolders

readonly attribute boolean nsIMsgFolder::canRename

can you change the name of this folder? for example, newsgroups and some special folders can't be renamed

readonly attribute boolean nsIMsgFolder::canCompact

the phantom server folder

does this folder have new messages

return the first new message in the folder

readonly attribute unsigned long nsIMsgFolder::expungedBytes

readonly attribute boolean nsIMsgFolder::deletable

can this folder be deleted? for example, special folders cannot be deleted

should we be displaying recipients instead of the sender? for example, in the Sent folder, recipients are more relevant than the sender

used to determine if it will take a long time to download all the headers in this folder - so that we can do folder notifications synchronously instead of asynchronously

this should go into a news-specific interface

this should go into a news-specific interface

readonly attribute ACString nsIMsgFolder::relativePathName

attribute unsigned long nsIMsgFolder::sizeOnDisk

size of this folder on disk (not including .msf file) for imap, it's the sum of the size of the messages

readonly attribute ACString nsIMsgFolder::username

readonly attribute ACString nsIMsgFolder::hostname

attribute unsigned long nsIMsgFolder::flags

Direct access to the set/get all the flags at once.

readonly attribute boolean nsIMsgFolder::locked

attribute ACString nsIMsgFolder::charset

the charset of this folder

attribute unsigned long nsIMsgFolder::biffState

are we running a url as a result of the user clicking get msg?

local path of this folder

readonly attribute ACString nsIMsgFolder::baseMessageURI

Turn notifications on/off for various notification types.

Currently only supporting allMessageCountNotifications which refers to both total and unread message counts.

attribute long nsIMsgFolder::sortOrder

used for order in the folder pane, folder pickers, etc.

readonly attribute ACString nsIMsgFolder::URI

attribute AString nsIMsgFolder::name

attribute AString nsIMsgFolder::prettyName

readonly attribute AString nsIMsgFolder::abbreviatedName

Returns an enumerator containing a list of nsIMsgFolder items that are subfolders of the instance this is called on.

Returns true if this folder has sub folders.

readonly attribute unsigned long nsIMsgFolder::numSubFolders

Returns the number of sub folders that this folder has.


The documentation for this interface was generated from the following file:

Generated Mozilla by doxygen 1.5.6