Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIMsgComposeService Interface Reference

import "nsIMsgComposeService.idl";

Inheritance diagram for nsIMsgComposeService:
Inheritance graph
[legend]
Collaboration diagram for nsIMsgComposeService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void OpenComposeWindow (in string msgComposeWindowURL, in string originalMsgURI, in MSG_ComposeType type, in MSG_ComposeFormat format, in nsIMsgIdentity identity, in nsIMsgWindow aMsgWindow)
void OpenComposeWindowWithURI (in string msgComposeWindowURL, in nsIURI aURI)
void OpenComposeWindowWithParams (in string msgComposeWindowURL, in nsIMsgComposeParams params)
nsIMsgCompose InitCompose (in nsIDOMWindowInternal aWindow, in nsIMsgComposeParams params)
void TimeStamp (in string label, in boolean resetTime)
boolean determineComposeHTML (in nsIMsgIdentity aIdentity, in MSG_ComposeFormat aFormat)
void cacheWindow (in nsIDOMWindowInternal aWindow, in boolean aComposeHTML, in nsIMsgComposeRecyclingListener listener)
boolean isCachedWindow (in nsIDOMWindowInternal aWindow)
nsIMsgComposeParams getParamsForMailto (in nsIURI aURI)
 given a mailto url, parse the attributes and turn them into a nsIMsgComposeParams object
void forwardMessage (in AString forwardTo, in nsIMsgDBHdr aMsgHdr, in nsIMsgWindow aMsgWindow, in nsIMsgIncomingServer aServer)
void replyWithTemplate (in nsIMsgDBHdr msgHdr, in string templateUri, in nsIMsgWindow aMsgWindow, in nsIMsgIncomingServer server)
void registerComposeWindow (in nsIDOMWindowInternal aWindow, in nsIMsgCompose aMsgCompose)
 Every open compose window registers itself with the compose service This allows consumers to get the msg compose object associated with a dom window.
void unregisterComposeWindow (in nsIDOMWindowInternal aWindow)
 When a compose window is being closed (or recyled), it unregisters itself from the compose service.
nsIMsgCompose getMsgComposeForWindow (in nsIDOMWindowInternal aWindow)
 For aWindow, returns the nsIMsgCompose object associated with the window.

Public Attributes

readonly attribute nsIMsgIdentity defaultIdentity
 defaultIdentity
readonly attribute boolean logComposePerformance

Detailed Description

Definition at line 51 of file nsIMsgComposeService.idl.


Member Function Documentation

void nsIMsgComposeService::forwardMessage ( in AString  forwardTo,
in nsIMsgDBHdr  aMsgHdr,
in nsIMsgWindow  aMsgWindow,
in nsIMsgIncomingServer  aServer 
)

For aWindow, returns the nsIMsgCompose object associated with the window.

Parameters:
aWindowThe DOMWindow associated with the compose window.
Returns:
NS_ERROR_FAILURE if we could not find a nsIMsgCompose for the passed in DOM Window.

given a mailto url, parse the attributes and turn them into a nsIMsgComposeParams object

Returns:
nsIMsgComposeParams which corresponds to the passed in mailto url
void nsIMsgComposeService::OpenComposeWindow ( in string  msgComposeWindowURL,
in string  originalMsgURI,
in MSG_ComposeType  type,
in MSG_ComposeFormat  format,
in nsIMsgIdentity  identity,
in nsIMsgWindow  aMsgWindow 
)

Every open compose window registers itself with the compose service This allows consumers to get the msg compose object associated with a dom window.

Parameters:
aWindowThe DOM Window
aMsgComposeThe compose object associated with the compose window

When a compose window is being closed (or recyled), it unregisters itself from the compose service.

Parameters:
aWindowThe DOM Window

Member Data Documentation

defaultIdentity

Returns:
the default identity, in case no identity has been setup yet, will return null

Definition at line 78 of file nsIMsgComposeService.idl.

Definition at line 84 of file nsIMsgComposeService.idl.


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