User:Clarkbw/STEEL/0.1/STEEL:Folder

From MozillaWiki
< User:Clarkbw‎ | STEEL‎ | 0.1
Jump to: navigation, search

Method Overview

boolean has(in AString msgID)
steelIMessage get(in AString msgID)
void addSubFolder(in AString folderName)
void deleteSubFolder(in AString folderName)
void markAsRead()
void compact()

Attributes

Attribute Type Description Examples
name readonly attribute AString List of account objects (steelIAccount) like email and newsgroups.
subFolders readonly attribute [array] steelIFolders List of address books like Local, LDAP, and others. Watch for Sub-Folders Added / Removed
unreadMsgs readonly attribute [array] steelIMessage Provides access to global Thunderbird preferences, for extension only preferences use the extension object below.
allMsgs readonly attribute [array] steelIMessage List of extensions known to Thunderbird, provides access to all extension information and their preferences.
events readonly attribute steelIEvents Event object for adding and removing listeners to the Application level

Methods

has()

Check if a folder has a message with the ID passed

Parameters
msgID
Message ID to check for
Return value

none

get()

Get a message from this folder by it's ID

Parameters
msgID
Message ID to look for in the Folder
Return Value
steelIMessage
Message object with an ID matching the ID passed into the method

addSubFolder()

Add a sub folder to this folder

Parameters
folderName
Name of the new folder to create as a sub folder to this folder
Return Value

none

deleteSubFolder()

Delete a sub folder from this folder

Parameters
folderName
Name of the sub folder to delete from this folder
Return Value

none

markAsRead()

Mark the entire folder as read

Parameters

none

Return Value

none

compact()

Compact the folder for space

Parameters

none

Return Value

none

Events

  • newMail — A new message has arrived in this folder
  • folderAdded — A new sub folder has been added to this folder
  • folderRemoved — A sub folder has been removed from this folder

See Also