User:Clarkbw/STEEL/0.1/STEEL:Account

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

Method Overview

nsIVariant (steelIMessage) getMessages()
steelIMessage getNewMessage()
void addFolder(in AString folderName)
void deleteFolder(in AString folderName)

Attributes

Attribute Type Description Examples
id readonly attribute AString ID attribute for this account List all Accounts
address readonly attribute AString Outgoing email address for this account List all Accounts
displayName readonly attribute AString Display name for this account, defaults to the address List all Accounts
type readonly attribute integer Type of account
  • imap — 1
  • pop3 — 2
  • nntp — 3
  • none — 4
List all Accounts
folders readonly attribute [array] steelIFolder Array of Folder objects for the top level of this account. Watch for New Mail, Watch for Sent Mail
events readonly attribute steelIEvents Event object for adding and removing listeners to the Application level Watch for Folders Being Added or Removed

Methods

getMessages()

Returns all messages in the root folder for this account

Parameters

none

Return value
nsIVariant
Array of messages (steelIMessage) at the root level of the account

getNewMessage()

Creates an empty message that can be sent from this account.

Parameters

none

Return Value
steelIMessage
New empty Message for use in sending from this account

addFolder()

Add a new folder to the top level of the Account

Parameters
folderName
String of folder name to be added
Return Value

none

deleteFolder()

Remove a folder from the top level of the Account.

Parameters
folderName
String of folder name to be deleted
Return Value

none

Events

  • newMail — triggers when a message is received in the account
  • folderAdded — triggers when a new folder is created at the top level of the Account
  • folderRemoved — triggers when a new folder is removed at the top level of the Account


See Also