nsIDBFolderInfo - careful, pulled from the wrong (cvs) repo!

mailnews/db/msgdb/public/nsIDBFolderInfo.idlScriptable

??? Add brief description of Interface ???

Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Implemented by: ?????????????????????????????????????. To create an instance, use:

Implemented by: ????????????????????????????????????? as a service:

var dBFolderInfo = Components.classes["@mozilla.org/????????????????????????????"]
                   .createInstance(Components.interfaces.nsIDBFolderInfo);

Method overview

long AndFlags(in long flags);

void ChangeExpungedBytes(in long delta);

void ChangeNumMessages(in long delta);

void ChangeNumUnreadMessages(in long delta);

boolean getBooleanProperty(in string propertyName, in boolean defaultValue);

void getCharacterSet(out ACString charSet, out boolean overriden);

void getCharacterSetOverride(out boolean characterSetOverride); Obsolete since Gecko 1.8

string getCharPtrCharacterSet();

string getCharPtrProperty(in string propertyName);

void getLocale(in nsString result); Native code only! Obsolete since Gecko 1.8

void getMailboxName(in nsString boxName); Native code only! Obsolete since Gecko 1.8

AString getProperty(in string propertyName);

nsIDBFolderInfo GetTransferInfo();

unsigned long getUint32Property(in string propertyName, in unsigned long defaultValue);

void initFromTransferInfo(in nsIDBFolderInfo transferInfo);

long OrFlags(in long flags);

void setBooleanProperty(in string propertyName, in boolean aPropertyValue);

void setCharacterSet(in string charSet);

void setCharacterSetOverride(in boolean characterSetOverride); Obsolete since Gecko 1.8

void setCharPtrProperty(in string aPropertyName, in string aPropertyValue);

void SetHighWater(in nsMsgKey highwater, in boolean force);

void setLocale(in nsString locale); Native code only! Obsolete since Gecko 1.8

void setMailboxName(in nsString newBoxName); Native code only! Obsolete since Gecko 1.8

void setProperty(in string propertyName, in AString propertyStr);

void setUint32Property(in string propertyName, in unsigned long propertyValue);

Attributes

Attribute	Type	Description
`characterSetOverride`	`boolean`
`ExpiredMark`	`nsMsgKey`
`expungedBytes`	`long`
`Flags`	`long`
`FolderDate`	`unsigned long`
`folderName`	`string`
`FolderSize`	`unsigned long`
`HighWater`	`nsMsgKey`
`IMAPHierarchySeparator`	`wchar`
`ImapTotalPendingMessages`	`long`
`ImapUidValidity`	`long`
`ImapUnreadPendingMessages`	`long`
`knownArtsSet`	`string`
`locale`	`AString`
`mailboxName`	`AString`
`NumMessages`	`long`
`NumUnreadMessages`	`long`
`sortOrder`	`nsMsgViewSortOrderValue`
`sortType`	`nsMsgViewSortTypeValue`
`Version`	`unsigned long`
`viewFlags`	`nsMsgViewFlagsTypeValue`
`viewType`	`nsMsgViewTypeValue`

Methods

AndFlags()

long AndFlags(
  in long flags
);

Parameters

flags: Missing Description

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

ChangeExpungedBytes()

void ChangeExpungedBytes(
  in long delta
);

Parameters

delta: Missing Description

Exceptions thrown

Missing Exception: Missing Description

ChangeNumMessages()

void ChangeNumMessages(
  in long delta
);

Parameters

delta: Missing Description

Exceptions thrown

Missing Exception: Missing Description

ChangeNumUnreadMessages()

void ChangeNumUnreadMessages(
  in long delta
);

Parameters

delta: Missing Description

Exceptions thrown

Missing Exception: Missing Description

getBooleanProperty()

boolean getBooleanProperty(
  in string propertyName,
  in boolean defaultValue
);

Parameters

propertyName: Missing Description
defaultValue: Missing Description

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

getCharacterSet()

void getCharacterSet(
  out ACString charSet,
  out boolean overriden
);

Parameters

charSet: Missing Description
overriden: Missing Description

Exceptions thrown

Missing Exception: Missing Description

getCharacterSetOverride()

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

void getCharacterSetOverride(
  out boolean characterSetOverride
);

Parameters

characterSetOverride: Missing Description

Exceptions thrown

Missing Exception: Missing Description

getCharPtrCharacterSet()

string getCharPtrCharacterSet();

Parameters

None.

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

getCharPtrProperty()

string getCharPtrProperty(
  in string propertyName
);

Parameters

propertyName: Missing Description

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

Native code only!

getLocale

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

void getLocale(
  in nsString result
);

Parameters

result: Missing Description

Exceptions thrown

Missing Exception: Missing Description

Native code only!

getMailboxName

void getMailboxName(
  in nsString boxName
);

Parameters

boxName: Missing Description

Exceptions thrown

Missing Exception: Missing Description

getProperty()

AString getProperty(
  in string propertyName
);

Parameters

propertyName: Missing Description

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

GetTransferInfo()

nsIDBFolderInfo GetTransferInfo();

Parameters

None.

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

getUint32Property()

unsigned long getUint32Property(
  in string propertyName,
  in unsigned long defaultValue
);

Parameters

propertyName: Missing Description
defaultValue: Missing Description

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

initFromTransferInfo()

void initFromTransferInfo(
  in nsIDBFolderInfo transferInfo
);

Parameters

transferInfo: Missing Description

Exceptions thrown

Missing Exception: Missing Description

OrFlags()

long OrFlags(
  in long flags
);

Parameters

flags: Missing Description

Return value

Missing Description

Exceptions thrown

Missing Exception: Missing Description

setBooleanProperty()

void setBooleanProperty(
  in string propertyName,
  in boolean aPropertyValue
);

Parameters

propertyName: Missing Description
aPropertyValue: Missing Description

Exceptions thrown

Missing Exception: Missing Description

setCharacterSet()

void setCharacterSet(
  in string charSet
);

Parameters

charSet: Missing Description

Exceptions thrown

Missing Exception: Missing Description

setCharacterSetOverride()

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

void setCharacterSetOverride(
  in boolean characterSetOverride
);

Parameters

characterSetOverride: Missing Description

Exceptions thrown

Missing Exception: Missing Description

setCharPtrProperty()

void setCharPtrProperty(
  in string aPropertyName,
  in string aPropertyValue
);

Parameters

aPropertyName: Missing Description
aPropertyValue: Missing Description

Exceptions thrown

Missing Exception: Missing Description

SetHighWater()

void SetHighWater(
  in nsMsgKey highwater,
  in boolean force
);

Parameters

highwater: Missing Description
force: Missing Description

Exceptions thrown

Missing Exception: Missing Description

Native code only!

setLocale

void setLocale(
  in nsString locale
);

Parameters

locale: Missing Description

Exceptions thrown

Missing Exception: Missing Description

Native code only!

setMailboxName

void setMailboxName(
  in nsString newBoxName
);

Parameters

newBoxName: Missing Description

Exceptions thrown

Missing Exception: Missing Description

setProperty()

void setProperty(
  in string propertyName,
  in AString propertyStr
);

Parameters

propertyName: Missing Description
propertyStr: Missing Description

Exceptions thrown

Missing Exception: Missing Description

setUint32Property()

void setUint32Property(
  in string propertyName,
  in unsigned long propertyValue
);