WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIDBFolderInfo

IID:83254767-a395-4bc6-be46-78687c5f1bba
Inherits From:nsISupports

Properties

ACString 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.

PRBool characterSetOverride

readonly ACString 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.

nsMsgKey ExpiredMark

PRInt32 expungedBytes

PRInt32 Flags

PRUint32 FolderDate

ACString folderName

PRUint32 FolderSize

nsMsgKey HighWater

PRUnichar IMAPHierarchySeparator

PRInt32 ImapTotalPendingMessages

PRInt32 ImapUidValidity

PRInt32 ImapUnreadPendingMessages

char* knownArtsSet

AString locale

AString mailboxName

PRInt32 NumMessages

PRInt32 NumUnreadMessages

nsMsgViewSortOrderValue sortOrder

nsMsgViewSortTypeValue sortType

PRUint32 Version

nsMsgViewFlagsTypeValue viewFlags

nsMsgViewTypeValue viewType

Methods

PRInt32 AndFlags ( PRInt32 flags ) void ChangeExpungedBytes ( PRInt32 delta ) void ChangeNumMessages ( PRInt32 delta ) void ChangeNumUnreadMessages ( PRInt32 delta ) PRBool getBooleanProperty ( char* propertyName , PRBool defaultValue ) ACString getCharProperty ( char* propertyName ) AString getProperty ( char* propertyName ) nsIDBFolderInfo GetTransferInfo ( ) PRUint32 getUint32Property ( char* propertyName , PRUint32 defaultValue ) void initFromTransferInfo ( nsIDBFolderInfo transferInfo ) PRInt32 OrFlags ( PRInt32 flags ) void setBooleanProperty ( char* propertyName , PRBool propertyValue ) void setCharProperty ( char* propertyName , ACString propertyValue ) void SetHighWater ( nsMsgKey highwater , PRBool force ) void setProperty ( char* propertyName , AString propertyStr ) void setUint32Property ( char* propertyName , PRUint32 propertyValue )

PRInt32 AndFlags ( PRInt32 flags )

Arguments:
flags

void ChangeExpungedBytes ( PRInt32 delta )

Arguments:
delta

void ChangeNumMessages ( PRInt32 delta )

Arguments:
delta

void ChangeNumUnreadMessages ( PRInt32 delta )

Arguments:
delta

PRBool getBooleanProperty ( char* propertyName , PRBool defaultValue )

Arguments:
propertyName
defaultValue

ACString getCharProperty ( char* propertyName )

Gets a string property from the folder.

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

AString getProperty ( char* propertyName )

Arguments:
propertyName

nsIDBFolderInfo GetTransferInfo ( )

PRUint32 getUint32Property ( char* propertyName , PRUint32 defaultValue )

Arguments:
propertyName
defaultValue

void initFromTransferInfo ( nsIDBFolderInfo transferInfo )

Arguments:
transferInfo

PRInt32 OrFlags ( PRInt32 flags )

Arguments:
flags

void setBooleanProperty ( char* propertyName , PRBool propertyValue )

Arguments:
propertyName
propertyValue

void setCharProperty ( char* propertyName , ACString propertyValue )

Sets a string property from the folder.

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

void SetHighWater ( nsMsgKey highwater , PRBool force )

Arguments:
highwater
force

void setProperty ( char* propertyName , AString propertyStr )

Arguments:
propertyName
propertyStr

void setUint32Property ( char* propertyName , PRUint32 propertyValue )

Arguments:
propertyName
propertyValue

References

This interface is the type of the following properties:

nsIMsgDatabase.dBFolderInfo, nsIMsgFolder.dBTransferInfo

This interface is passed as an argument to the following methods:

nsIDBFolderInfo.initFromTransferInfo, nsIMsgFolder.getDBFolderInfoAndDB

This interface is returned from the following methods:

nsIDBFolderInfo.GetTransferInfo

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com