nsIDBFolderInfo Interface Reference

import "nsIDBFolderInfo.idl";

Inheritance diagram for nsIDBFolderInfo:

Inheritance graph
[legend]
Collaboration diagram for nsIDBFolderInfo:

Collaboration graph
[legend]

List of all members.

Public Member Functions

long orFlags (in long aFlags)
 Or's aFlags into flags.
long andFlags (in long aFlags)
 And's aFlags with flags, set flags to the result.
void onKeyAdded (in nsMsgKey aNewKey)
 Allows us to keep track of the highwater mark.
void changeNumUnreadMessages (in long aDelta)
void changeNumMessages (in long aDelta)
void changeExpungedBytes (in long aDelta)
ACString getCharProperty (in string propertyName)
 Gets a string property from the folder.
void setCharProperty (in string aPropertyName, in ACString aPropertyValue)
 Sets a string property from the folder.
void setUint32Property (in string propertyName, in unsigned long propertyValue)
unsigned long getUint32Property (in string propertyName, in unsigned long defaultValue)
boolean getBooleanProperty (in string propertyName, in boolean defaultValue)
void setBooleanProperty (in string propertyName, in boolean aPropertyValue)
nsIDBFolderInfo GetTransferInfo ()
void initFromTransferInfo (in nsIDBFolderInfo transferInfo)
AString getProperty (in string propertyName)
void setProperty (in string propertyName, in AString propertyStr)

Public Attributes

attribute long flags
attribute nsMsgKey highWater
attribute nsMsgKey expiredMark
attribute unsigned long folderSize
attribute unsigned long folderDate
attribute long numUnreadMessages
attribute long numMessages
attribute long expungedBytes
attribute long imapUidValidity
attribute unsigned long version
attribute long imapTotalPendingMessages
attribute long imapUnreadPendingMessages
attribute nsMsgViewTypeValue viewType
attribute nsMsgViewFlagsTypeValue viewFlags
attribute nsMsgViewSortTypeValue sortType
attribute nsMsgViewSortOrderValue sortOrder
attribute ACString characterSet
 Gets/Sets the current character set for the folder.
readonly attribute ACString effectiveCharacterSet
 Returns the effective character set on the folder.
attribute boolean characterSetOverride
attribute AString locale
attribute AString mailboxName
attribute string knownArtsSet
attribute ACString folderName


Member Function Documentation

long nsIDBFolderInfo::orFlags ( in long  aFlags  ) 

Or's aFlags into flags.

Parameters:
- the flags(s) to set
Returns:
- the resulting flags.

long nsIDBFolderInfo::andFlags ( in long  aFlags  ) 

And's aFlags with flags, set flags to the result.

Parameters:
the flags(s) to AND
Returns:
the resulting flags.

void nsIDBFolderInfo::onKeyAdded ( in nsMsgKey  aNewKey  ) 

Allows us to keep track of the highwater mark.

Parameters:
aNewKey If larger than the current highwater mark, sets the highwater mark to aNewKey.

void nsIDBFolderInfo::changeNumUnreadMessages ( in long  aDelta  ) 

void nsIDBFolderInfo::changeNumMessages ( in long  aDelta  ) 

void nsIDBFolderInfo::changeExpungedBytes ( in long  aDelta  ) 

ACString nsIDBFolderInfo::getCharProperty ( in string  propertyName  ) 

Gets a string property from the folder.

Parameters:
propertyName The name of the property for the value to retrieve.

void nsIDBFolderInfo::setCharProperty ( in string  aPropertyName,
in ACString  aPropertyValue 
)

Sets a string property from the folder.

Parameters:
propertyName The name of the property for which to set a value
propertyValue The new value of the property.

void nsIDBFolderInfo::setUint32Property ( in string  propertyName,
in unsigned long  propertyValue 
)

unsigned long nsIDBFolderInfo::getUint32Property ( in string  propertyName,
in unsigned long  defaultValue 
)

boolean nsIDBFolderInfo::getBooleanProperty ( in string  propertyName,
in boolean  defaultValue 
)

void nsIDBFolderInfo::setBooleanProperty ( in string  propertyName,
in boolean  aPropertyValue 
)

nsIDBFolderInfo nsIDBFolderInfo::GetTransferInfo (  ) 

void nsIDBFolderInfo::initFromTransferInfo ( in nsIDBFolderInfo  transferInfo  ) 

AString nsIDBFolderInfo::getProperty ( in string  propertyName  ) 

void nsIDBFolderInfo::setProperty ( in string  propertyName,
in AString  propertyStr 
)


Member Data Documentation

attribute long nsIDBFolderInfo::flags

attribute unsigned long nsIDBFolderInfo::folderSize

attribute unsigned long nsIDBFolderInfo::folderDate

attribute unsigned long nsIDBFolderInfo::version

attribute ACString nsIDBFolderInfo::characterSet

Gets/Sets the current character set for the folder.

If there is no specific character set for the folder, it will return an empty string.

readonly attribute ACString nsIDBFolderInfo::effectiveCharacterSet

Returns the effective character set on the folder.

If there is no specific set defined for the folder, it will return the default character set.

attribute AString nsIDBFolderInfo::locale

attribute AString nsIDBFolderInfo::mailboxName

attribute ACString nsIDBFolderInfo::folderName


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

Generated Mozilla by doxygen 1.5.6