Revision control
Copy as Markdown
Other Tools
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
#include "nsISupports.idl"
#include "nsIFolderListener.idl"
#include "nsIMsgIncomingServer.idl"
#include "nsIMsgCopyServiceListener.idl"
#include "nsIUrlListener.idl"
#include "nsIMsgEnumerator.idl"
interface nsIMsgDBHdr;
interface nsIMsgWindow;
interface nsIMsgDatabase;
interface nsIDBFolderInfo;
interface nsIMsgFilterList;
interface nsIFile;
interface nsIOutputStream;
interface nsIInputStream;
interface nsIMsgIdentity;
interface nsIMsgThread;
interface nsIMsgPluggableStore;
interface nsIPropertyBag2;
typedef long nsMsgBiffState;
// enumerated type for determining if a message has been replied to, forwarded, etc.
typedef long nsMsgDispositionState;
/*
* The contract ID for this component is @mozilla.org/msgFolder/msgFolderService;1.
*/
[scriptable, uuid(5639c204-48ac-4115-897f-3b16821fe118)]
interface nsIMsgFolderService : nsISupports
{
/**
* JS-callable service to initialize static variables in nsMsgDBFolder.cpp
* upon initialization or when locale changes.
*/
void initializeFolderStrings();
};
[scriptable, uuid(5d253ba2-42aa-43a7-b584-0059855ababf)]
interface nsIMsgFolder : nsISupports {
const nsMsgBiffState nsMsgBiffState_NewMail = 0; // User has new mail waiting.
const nsMsgBiffState nsMsgBiffState_NoMail = 1; // No new mail is waiting.
const nsMsgBiffState nsMsgBiffState_Unknown = 2; // We dunno whether there is new mail.
/* folder name properties */
readonly attribute AUTF8String URI;
attribute AString name;
attribute AString prettyName;
readonly attribute AString abbreviatedName;
readonly attribute AString prettyPath;
%{C++
/**
* C++ shortcut to folder URI, for logging and debugging.
*/
nsCString URI();
%}
/**
* Set pretty name again from original name,
* typically used when locale changes.
*/
void setPrettyNameFromOriginal();
attribute nsIMsgFolder parent;
/// Returns an enumerator containing the messages within the current database.
readonly attribute nsIMsgEnumerator messages;
/**
* This method is called by the folder-lookup-service after constructing
* a folder to initialize its URI. You would not normally
* call this method directly.
*
* @param uri - The URI of the folder.
*/
void Init(in AUTF8String uri);
void startFolderLoading();
void endFolderLoading();
void folderNamesReady(out boolean aReady);
/* get new headers for db */
void updateFolder(in nsIMsgWindow aWindow);
/**
* URL for this folder
*/
readonly attribute AUTF8String folderURL;
/**
* should probably move to the server
*/
readonly attribute boolean showDeletedMessages;
/**
* this folder's parent server
*/
readonly attribute nsIMsgIncomingServer server;
/**
* is this folder the "phantom" server folder?
*/
readonly attribute boolean isServer;
readonly attribute boolean canSubscribe;
readonly attribute boolean canFileMessages;
readonly attribute boolean noSelect; // this is an imap no select folder
readonly attribute boolean imapShared; // this is an imap shared folder
readonly attribute boolean canDeleteMessages; // can't delete from imap read-only
/**
* does this folder allow subfolders?
* for example, newsgroups cannot have subfolders, and the INBOX
* on some IMAP servers cannot have subfolders
*/
readonly attribute boolean canCreateSubfolders;
/**
* can you change the name of this folder?
* for example, newsgroups
* and some special folders can't be renamed
*/
readonly attribute boolean canRename;
/**
* Can folder be compacted? Only applicable to folders using mbox storage.
* Doesn't mean a compaction operation will actually do anything - if there's
* nothing to compact, the compaction will be a no-op.
*/
readonly attribute boolean canCompact;
/**
* the phantom server folder
*/
readonly attribute nsIMsgFolder rootFolder;
/**
* Get the server's list of filters. (Or in the case of news, the
* filter list for this newsgroup)
* This list SHOULD be used for all incoming messages.
*
* Since the returned nsIMsgFilterList is mutable, it is not necessary to call
* setFilterList after the filters have been changed.
*
* @param aMsgWindow @ref msgwindow "The standard message window"
* @return The list of filters
*/
nsIMsgFilterList getFilterList(in nsIMsgWindow msgWindow);
/**
* Set the server's list of filters.
*
* Note that this does not persist the filter list. To change the contents
* of the existing filters, use getFilterList and mutate the values as
* appropriate.
*
* @param aFilterList The new list of filters.
*/
void setFilterList(in nsIMsgFilterList filterList);
/**
* Get user editable filter list. This does not have to be the same as
* the filterlist above, typically depending on the users preferences.
* The filters in this list are not processed, but only to be edited by
* the user.
* @see getFilterList
*
* @param aMsgWindow @ref msgwindow "The standard message window"
* @return The list of filters
*/
nsIMsgFilterList getEditableFilterList(in nsIMsgWindow aMsgWindow);
/**
* Set user editable filter list.
* This does not persist the filterlist, @see setFilterList
* @see getEditableFilterList
* @see setFilterList
*
* @param aFilterList The new list of filters.
*/
void setEditableFilterList(in nsIMsgFilterList aFilterList);
/**
* Force close the mail database associated with this folder.
*/
void ForceDBClosed();
/**
* Close and backup a folder database prior to reparsing
*
* @param newName New name of the corresponding message folder.
* Used in rename to set the file name to match the renamed
* folder. Set to empty to use the existing folder name.
*/
void closeAndBackupFolderDB(in ACString newName);
/**
* Delete the backing store of the folder, but not the folder itself.
*/
[noscript]
void deleteStorage();
/**
* Delete this folder and its children, if any.
* Note: this may mean moving it to trash and/or requesting confirmation
* from the user, depending on implementation.
* So the deletion may not take place immediately (or at all!)
*
* @param msgWindow msgWindow to display status feedback in
*/
void deleteSelf(in nsIMsgWindow msgWindow);
/**
* Delete the given subfolder of this folder.
* It does not need to be a direct child.
*
* @param folder a child subfolder to delete
* @param deleteStorage whether to also delete the folder storage on disk
*/
void propagateDelete(in nsIMsgFolder folder, in boolean deleteStorage);
/**
* Delete the folder and all of its subfolders.
*
* @param deleteStorage whether to also delete the folder storage on disk
*/
[noscript]
void recursiveDelete(in boolean deleteStorage);
/**
* Create a subfolder of the current folder with the passed in name.
* For IMAP, this will be an async operation and the folder won't exist
* until it is created on the server.
*
* @param folderName name of the folder to create.
* @param msgWindow msgWindow to display status feedback in.
*
* @exception NS_MSG_FOLDER_EXISTS
*/
void createSubfolder(in AString folderName, in nsIMsgWindow msgWindow);
/**
* Adds the subfolder with the passed name to the folder hierarchy.
* This is used internally during folder discovery; It shouldn't be
* used to create folders since it won't create storage for the folder,
* especially for imap. Unless you know exactly what you're doing, you
* should be using createSubfolder + getChildNamed or createLocalSubfolder.
*
* @param aFolderName Name of the folder to add.
* @returns The folder added.
*/
nsIMsgFolder addSubfolder(in AString aFolderName);
/* this method ensures the storage for the folder exists.
For local folders, it creates the berkeley mailbox if missing.
For imap folders, it subscribes to the folder if it exists,
or creates it if it doesn't exist
*/
void createStorageIfMissing(in nsIUrlListener urlListener);
/**
* Compact this folder (Expunge _and_ compact, for IMAP folders).
*
* @param aListener Notified upon completion, can be null.
* OnStartRunningUrl() will not be called.
* OnStopRunningUrl() will be called upon completion,
* with a null URL.
* @param aMsgWindow For progress/status, can be null.
*/
void compact(in nsIUrlListener aListener, in nsIMsgWindow aMsgWindow);
/**
* Compact all folders in the account corresponding to this folder.
*
* @param aListener Notified upon completion, can be null.
* OnStartRunningUrl() will not be called.
* OnStopRunningUrl() will be called upon completion,
* with a null URL.
* @param aMsgWindow For progress/status, can be null.
*/
void compactAll(in nsIUrlListener aListener, in nsIMsgWindow aMsgWindow);
void emptyTrash(in nsIUrlListener aListener);
/**
* change the name of the folder
*
* @param name the new name of the folder
*/
void rename(in AString name, in nsIMsgWindow msgWindow);
void renameSubFolders( in nsIMsgWindow msgWindow, in nsIMsgFolder oldFolder);
AString generateUniqueSubfolderName(in AString prefix,
in nsIMsgFolder otherFolder);
void updateSummaryTotals(in boolean force);
void summaryChanged();
/**
* get the total number of unread messages in this folder,
* or in all subfolders
*
* @param deep if true, descends into all subfolders and gets a grand total
*/
long getNumUnread(in boolean deep);
/**
* get the total number of messages in this folder,
* or in all subfolders
*
* @param deep if true, descends into all subfolders and gets a grand total
*/
long getTotalMessages(in boolean deep);
/**
* These functions are used for tricking the front end into thinking that we
* have more messages than are really in the DB. This is usually after an
* IMAP message copy where we don't want to do an expensive select until the
* user actually opens that folder. These functions are called when
* MSG_Master::GetFolderLineById is populating a MSG_FolderLine struct used
* by the FE.
*/
readonly attribute long numPendingUnread;
readonly attribute long numPendingTotalMessages;
void changeNumPendingUnread(in long delta);
void changeNumPendingTotalMessages(in long delta);
/**
* does this folder have new messages
*
*/
attribute boolean hasNewMessages;
/**
* Indicates whether this folder or any of its subfolders have new messages.
*/
readonly attribute boolean hasFolderOrSubfolderNewMessages;
/**
* return the first new message in the folder
*
*/
readonly attribute nsIMsgDBHdr firstNewMessage;
/**
* clear new status flag of all of the new messages
*/
void clearNewMessages();
readonly attribute long long expungedBytes;
/**
* Can this folder be deleted?
* For example, special folders and isServer folders cannot be deleted.
*/
readonly attribute boolean deletable;
/**
* 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 displayRecipients;
/**
* 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 manyHeadersToDownload;
readonly attribute ACString relativePathName;
/**
* size of this folder on disk (not including .msf file)
* for imap, it's the sum of the size of the messages
*/
attribute long long sizeOnDisk;
/**
* Aggregate size on disk of this folder and any folder
* nested under it.
*
* This attribute is computed by reading the sizeOnDisk attribute of the
* current folder and all of its sub-folders. This means its calculation can
* become costly if the folder has a lot of sub-folders.
*/
readonly attribute long long sizeOnDiskWithSubFolders;
readonly attribute ACString username;
readonly attribute ACString hostname;
/**
* Sets a flag on the folder. The known flags are defined in
* nsMsgFolderFlags.h.
*
* @param flag The flag to set on the folder.
*/
void setFlag(in unsigned long flag);
/**
* Clears a flag on the folder. The known flags are defined in
* nsMsgFolderFlags.h.
*
* @param flag The flag to clear on the folder.
*/
void clearFlag(in unsigned long flag);
/**
* Determines if a flag is set on the folder or not. The known flags are
* defined in nsMsgFolderFlags.h.
*
* @param flag The flag to check on the folder.
* @return True if the flag exists.
*/
boolean getFlag(in unsigned long flag);
/**
* Toggles a flag on the folder. The known flags are defined in
* nsMsgFolderFlags.h.
*
* @param flag The flag to toggle
*/
void toggleFlag(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.
*
* @param flag The flag that was changed.
*/
void onFlagChange(in unsigned long flag);
/**
* Direct access to the set/get all the flags at once.
*/
attribute unsigned long flags;
/**
* Gets the first folder that has the specified flags set.
*
* @param flags The flag(s) to check for.
* @return The folder or the first available child folder that has
* the specified flags set, or null if there are none.
*/
nsIMsgFolder getFolderWithFlags(in unsigned long flags);
/**
* Gets the folders that have the specified flag set.
*
* @param flags The flag(s) to check for.
* @return An array of folders that have the specified flags set.
* The array may have zero elements.
*/
Array<nsIMsgFolder> getFoldersWithFlags(in unsigned long flags);
/**
* Check if this folder (or one of its ancestors) is special.
*
* @param flags The "special" flags to check.
* @param checkAncestors Should ancestors be checked too.
*/
boolean isSpecialFolder(in unsigned long flags,
[optional] in boolean checkAncestors);
AUTF8String getUriForMsg(in nsIMsgDBHdr msgHdr);
/**
* Deletes the messages from the folder.
*
* @param messages The array of nsIMsgDBHdr objects to be deleted.
* @param msgWindow The standard message window object, for alerts et al.
* @param deleteStorage Whether or not the message should be truly deleted, as
opposed to moving to trash.
* @param isMove Whether or not this is a deletion for moving messages.
* @param allowUndo Whether this action should be undoable.
*/
void deleteMessages(in Array<nsIMsgDBHdr> messages,
in nsIMsgWindow msgWindow,
in boolean deleteStorage, in boolean isMove,
in nsIMsgCopyServiceListener listener, in boolean allowUndo);
void copyMessages(in nsIMsgFolder srcFolder, in Array<nsIMsgDBHdr> 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 ACString aKeywords,
in nsIMsgWindow msgWindow,
in nsIMsgCopyServiceListener listener);
/**
* Attempt to lock folder for use by semHolder (which can be basically anything).
* Fails with NS_MSG_FOLDER_BUSY if already locked.
* NOTE: Despite name, there is no threadsafe mechanism being used here.
*/
void acquireSemaphore(in nsISupports semHolder);
/**
* Releases lock held by semHolder.
* Has no effect if semHolder does not currently hold the lock.
* NOTE: Despite name, there is no threadsafe mechanism being used here.
*/
void releaseSemaphore(in nsISupports semHolder);
/**
* Returns true if folder is currently locked by semHolder.
* NOTE: Despite name, there is no threadsafe mechanism being used here.
*/
boolean testSemaphore(in nsISupports semHolder);
/**
* The locked attribute is true if folder is currently locked by anyone.
*/
readonly attribute boolean locked;
void getNewMessages(in nsIMsgWindow aWindow, in nsIUrlListener aListener);
/**
* Write out summary data for this folder to the given folder cache.
*/
void writeToFolderCache(in nsIMsgFolderCache folderCache, in boolean deep);
attribute unsigned long biffState;
/**
* The number of new messages since this folder's last biff.
*
* @param deep if true, descends into all subfolders and gets a grand total
*/
long getNumNewMessages(in boolean deep);
void setNumNewMessages(in long numNewMessages);
/**
* are we running a url as a result of the user clicking get msg?
*/
attribute boolean gettingNewMessages;
/**
* local path of this folder
*/
attribute nsIFile filePath;
/// an nsIFile corresponding to the .msf file.
readonly attribute nsIFile summaryFile;
readonly attribute AUTF8String baseMessageURI;
AUTF8String generateMessageURI(in nsMsgKey msgKey);
const nsMsgDispositionState nsMsgDispositionState_None = -1;
const nsMsgDispositionState nsMsgDispositionState_Replied = 0;
const nsMsgDispositionState nsMsgDispositionState_Forwarded = 1;
const nsMsgDispositionState nsMsgDispositionState_Redirected = 2;
void addMessageDispositionState(in nsIMsgDBHdr aMessage,
in nsMsgDispositionState aDispositionFlag);
void markMessagesRead(in Array<nsIMsgDBHdr> messages, in boolean markRead);
void markAllMessagesRead(in nsIMsgWindow aMsgWindow);
void markMessagesFlagged(in Array<nsIMsgDBHdr> messages, in boolean markFlagged);
void markThreadRead(in nsIMsgThread thread);
/**
* Gets the message database for the folder.
*
* Note that if the database is out of date, the implementation MAY choose to
* throw an error. For a handle to the database which MAY NOT throw an error,
* one can use getDBFolderInfoAndDB.
*
* The attribute can also be set to another database or to null to force the
* folder to reopen the same database when it is needed again.
*
* @exception NS_MSG_ERROR_FOLDER_SUMMARY_MISSING If the database does not
* exist.
* @exception NS_MSG_ERROR_FOLDER_SUMMARY_OUT_OF_DATE If the database contains
* out of date information.
* @see nsIMsgFolder::getDBFolderInfoAndDB.
*/
attribute nsIMsgDatabase msgDatabase;
/// Close the database if not open in folder.
void closeDBIfFolderNotOpen(in boolean forceClosed);
/// Does the folder have a local reference to the msgDatabase?
readonly attribute boolean databaseOpen;
/**
* Get the backup message database, used in reparsing. This database must
* be created first using closeAndBackupFolderDB()
*
* @return backup message database
*/
nsIMsgDatabase getBackupMsgDatabase();
/**
* Remove the backup message database file
*/
void removeBackupMsgDatabase();
/**
* Open the backup message database file
*/
void openBackupMsgDatabase();
nsIMsgDatabase getDBFolderInfoAndDB(out nsIDBFolderInfo folderInfo);
nsIMsgDBHdr GetMessageHeader(in nsMsgKey msgKey);
readonly attribute boolean supportsOffline;
boolean shouldStoreMsgOffline(in nsMsgKey msgKey);
boolean hasMsgOffline(in nsMsgKey msgKey);
/**
* Discard the msgStore offline copy of this message (if there is one).
* If there is no offline copy, this has no effect.
*/
void discardOfflineMsg(in nsMsgKey msgKey);
/**
* Get an offline store output stream for the passed message header.
*
* @param aHdr hdr of message to get outputstream for
* @returns An output stream to write to.
*/
nsIOutputStream getOfflineStoreOutputStream(in nsIMsgDBHdr aHdr);
/**
* Use getLocalMsgStream() instead.
*
* Get an input stream for the passed message header. The stream will
* be positioned at the start of the message.
*
* @param aHdr hdr of message to get the input stream for.
* @returns an input stream to read the message from
*/
nsIInputStream getMsgInputStream(in nsIMsgDBHdr aHdr);
/**
* Returns an input stream for reading a locally-stored message.
* (That means any message in a local folder, or a message marked as
* Offline on a non-local folder).
* The stream contains the single message.
* The returned stream should _not_ be considered seekable.
*
* @param hdr The message to get the input stream for.
* @returns Input stream to read the message from.
*/
nsIInputStream getLocalMsgStream(in nsIMsgDBHdr aHdr);
void downloadMessagesForOffline(in Array<nsIMsgDBHdr> messages,
in nsIMsgWindow window);
nsIMsgFolder getChildWithURI(in AUTF8String uri, in boolean deep,
in boolean caseInsensitive);
void downloadAllForOffline(in nsIUrlListener listener, in nsIMsgWindow window);
/**
* Turn notifications on/off for various notification types. Currently only
* supporting allMessageCountNotifications which refers to both total and
* unread message counts.
*/
const unsigned long allMessageCountNotifications = 0;
void enableNotifications(in long notificationType, in boolean enable);
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();
/**
* Calculate ordering of this folder against another.
*/
long compareSortKeys(in nsIMsgFolder msgFolder);
attribute nsIMsgRetentionSettings retentionSettings;
attribute nsIMsgDownloadSettings downloadSettings;
boolean callFilterPlugins(in nsIMsgWindow aMsgWindow);
/**
* used for order in the folder pane, folder pickers, etc.
*/
attribute long sortOrder;
attribute nsIPropertyBag2 dBTransferInfo;
/**
* Set a string property on the folder.
*/
void setStringProperty(in string propertyName, in AUTF8String propertyValue);
/**
* Returns the value of a string property, or an empty string if the property
* is not found.
*/
AUTF8String getStringProperty(in string propertyName);
/* does not persist across sessions */
attribute nsMsgKey lastMessageLoaded;
/**
* Returns an array containing nsIMsgFolder items that are
* subfolders (direct children) of the instance this is called on.
*/
readonly attribute Array<nsIMsgFolder> subFolders;
/**
* Returns true if this folder has sub folders.
*/
readonly attribute boolean hasSubFolders;
/**
* Returns the number of sub folders that this folder has.
*/
readonly attribute unsigned long numSubFolders;
/**
* Determines if this folder is an ancestor of the supplied folder.
*
* @param folder The folder that may or may not be a descendant of this
* folder.
*/
boolean isAncestorOf(in nsIMsgFolder folder);
/**
* Looks in immediate children of this folder for the given name.
*
* @param name the name of the target subfolder
*/
boolean containsChildNamed(in AString name);
/**
* Return the child folder which the specified name.
*
* @param aName The name of the child folder to find
* @return The child folder
* @exception NS_ERROR_FAILURE Thrown if the folder with aName does not exist
*/
nsIMsgFolder getChildNamed(in AString aName);
/**
* Finds the sub folder with the specified name.
*
* @param escapedSubFolderName The name of the sub folder to find.
* @note Even if the folder doesn't currently exist,
* a nsIMsgFolder may be returned.
*/
nsIMsgFolder findSubFolder(in ACString escapedSubFolderName);
void AddFolderListener(in nsIFolderListener listener);
void RemoveFolderListener(in nsIFolderListener listener);
// These notification functions invoke the appropriate nsIFolderListener
// method on all the listeners attached to this folder, and _also_
// all the nsIFolderListeners registered in the MailSession.
// See nsIMsgMailSession AddFolderListener()/RemoveFolderListener().
void NotifyPropertyChanged(in ACString property,
in ACString oldValue,
in ACString newValue);
void NotifyIntPropertyChanged(in ACString property,
in long long oldValue,
in long long newValue);
void NotifyBoolPropertyChanged(in ACString property,
in boolean oldValue,
in boolean newValue);
void NotifyPropertyFlagChanged(in nsIMsgDBHdr item,
in ACString property,
in unsigned long oldValue,
in unsigned long newValue);
void NotifyUnicharPropertyChanged(in ACString property,
in AString oldValue,
in AString newValue);
void notifyMessageAdded(in nsIMsgDBHdr msg);
void notifyMessageRemoved(in nsIMsgDBHdr msg);
void notifyFolderAdded(in nsIMsgFolder child);
void notifyFolderRemoved(in nsIMsgFolder child);
void NotifyFolderEvent(in ACString event);
// Gets all descendants, not just first level children.
readonly attribute Array<nsIMsgFolder> descendants;
void Shutdown(in boolean shutdownChildren);
void copyDataToOutputStreamForAppend(in nsIInputStream aIStream,
in long aLength, in nsIOutputStream outputStream);
void copyDataDone();
void setJunkScoreForMessages(in Array<nsIMsgDBHdr> aMessages, in ACString aJunkScore);
void applyRetentionSettings();
/**
* 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.
*
* @param aKeysToFetch keys of msgs to fetch
* @param aUrlListener url listener to notify if we run url to fetch msgs
*
* @result aAsyncResults if true, we ran a url to fetch one or more of msg bodies
*
*/
boolean fetchMsgPreviewText(in Array<nsMsgKey> aKeysToFetch,
in nsIUrlListener aUrlListener);
// used to set/clear tags - we could have a single method to setKeywords which
// would figure out the diffs, but these methods might be more convenient.
// keywords are space delimited, in the case of multiple keywords
void addKeywordsToMessages(in Array<nsIMsgDBHdr> aMessages, in ACString aKeywords);
void removeKeywordsFromMessages(in Array<nsIMsgDBHdr> aMessages, in ACString aKeywords);
/**
* Extract the message text from aStream.
*
* @param aStream stream to read from
* @param aCharset character set to use to interpret the body. If an empty string, then the
* charset is retrieved from the headers. msgHdr.charset is recommended in case you have it.
* @param aBytesToRead number of bytes to read from the stream. The function will read till the end
* of the line, and there will also be some read ahead due to NS_ReadLine
* @param aMaxOutputLen desired length of the converted message text. Used to control how many characters
* of msg text we want to store.
* @param aCompressQuotes Replace quotes and citations with " ... " in the preview text
* @param aStripHTMLTags strip HTML tags from the output, if present
* @param[out] aContentType the content type of the MIME part that was used to generate the text --
* for an HTML part, this will be "text/html" even though aStripHTMLTags might be true
*/
AUTF8String getMsgTextFromStream(in nsIInputStream aStream, in ACString aCharset,
in unsigned long aBytesToRead, in unsigned long aMaxOutputLen,
in boolean aCompressQuotes, in boolean aStripHTMLTags,
out ACString aContentType);
AString convertMsgSnippetToPlainText(in AString aMessageText);
// this allows a folder to have a special identity. E.g., you might want to
// associate an identity with a particular newsgroup, or for IMAP shared folders in
// the other users namespace, you might want to create a delegated identity
readonly attribute nsIMsgIdentity customIdentity;
/**
* @{
* Processing flags, used to manage message processing.
*
* @param msgKey message key
* @return processing flags
*/
unsigned long getProcessingFlags(in nsMsgKey msgKey);
/**
* @param msgKey message key
* @param mask mask to OR into the flags
*/
void orProcessingFlags(in nsMsgKey msgKey, in unsigned long mask);
/**
* @param msgKey message key
* @param mask mask to AND into the flags
*/
void andProcessingFlags(in nsMsgKey msgKey, in unsigned long mask);
/** @} */
/**
* Gets an inherited string property from the folder.
*
* If the forcePropertyEmpty boolean is set (see below), return an
* empty string.
*
* If the specified folder has a non-empty value for the property,
* return that value. Otherwise, return getInheritedStringProperty
* for the folder's parent.
*
* If a folder is the root folder for a server, then instead of
* checking the folder property, check the property of the same name
* for the server using nsIMsgIncomingServer.getCharValue(...)
*
* Note nsIMsgIncomingServer.getCharValue for a server inherits from
* the preference mail.server.default.(propertyName) as a global value
*
* (ex: if propertyName = "IAmAGlobal" and no folder nor server properties
* are set, then the inherited property will return the preference value
* mail.server.default.IAmAGlobal)
*
* If the propertyName is undefined, returns an empty, void string.
*
* @param propertyName The name of the property for the value to retrieve.
*/
ACString getInheritedStringProperty(in string propertyName);
/**
* Pluggable store for this folder. Currently, this will always be the same
* as the pluggable store for the server.
*/
readonly attribute nsIMsgPluggableStore msgStore;
/**
* Protocol type, i.e. "pop3", "imap", "nntp", "none", etc
* used to construct URLs for this account type.
*/
readonly attribute ACString incomingServerType;
};