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.

nsIMsgComposeService

IID:BC1C0379-82EF-45ae-9710-DD4FA93252F7
Inherits From:nsISupports

This interface is intended to be used as a service.

This interface is implemented by the following components:


Properties

readonly nsIMsgIdentity defaultIdentity

DefaultIdentity

readonly PRBool logComposePerformance


Methods

[noscript] void cacheWindow ( nsIDOMWindowInternal window , PRBool composeHTML , nsIMsgComposeRecyclingListener listener ) [noscript] PRBool determineComposeHTML ( nsIMsgIdentity identity , MSG_ComposeFormat format ) void forwardMessage ( AString forwardTo , nsIMsgDBHdr msgHdr , nsIMsgWindow msgWindow , nsIMsgIncomingServer server ) nsIMsgCompose getMsgComposeForWindow ( nsIDOMWindowInternal window ) nsIMsgComposeParams getParamsForMailto ( nsIURI URI ) nsIMsgCompose InitCompose ( nsIDOMWindowInternal window , nsIMsgComposeParams params ) PRBool isCachedWindow ( nsIDOMWindowInternal window ) void OpenComposeWindow ( char* msgComposeWindowURL , char* originalMsgURI , MSG_ComposeType type , MSG_ComposeFormat format , nsIMsgIdentity identity , nsIMsgWindow msgWindow ) void OpenComposeWindowWithParams ( char* msgComposeWindowURL , nsIMsgComposeParams params ) void OpenComposeWindowWithURI ( char* msgComposeWindowURL , nsIURI URI ) void registerComposeWindow ( nsIDOMWindowInternal window , nsIMsgCompose msgCompose ) void replyWithTemplate ( nsIMsgDBHdr msgHdr , char* templateUri , nsIMsgWindow msgWindow , nsIMsgIncomingServer server ) void TimeStamp ( char* label , PRBool resetTime ) void unregisterComposeWindow ( nsIDOMWindowInternal window )

void cacheWindow ( nsIDOMWindowInternal window , PRBool composeHTML , nsIMsgComposeRecyclingListener listener )

Arguments:
window
composeHTML
listener

PRBool determineComposeHTML ( nsIMsgIdentity identity , MSG_ComposeFormat format )

Arguments:
identity
format

void forwardMessage ( AString forwardTo , nsIMsgDBHdr msgHdr , nsIMsgWindow msgWindow , nsIMsgIncomingServer server )

Arguments:
forwardTo
msgHdr
msgWindow
server

nsIMsgCompose getMsgComposeForWindow ( nsIDOMWindowInternal window )

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

Arguments:
window: The DOMWindow associated with the compose window.
Returns:
nsIMsgCompose for the passed in DOM Window.

nsIMsgComposeParams getParamsForMailto ( nsIURI URI )

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

Arguments:
URI
Returns:
nsIMsgComposeParams which corresponds to the passed in mailto url

nsIMsgCompose InitCompose ( nsIDOMWindowInternal window , nsIMsgComposeParams params )

Arguments:
window
params

PRBool isCachedWindow ( nsIDOMWindowInternal window )

Arguments:
window

void OpenComposeWindow ( char* msgComposeWindowURL , char* originalMsgURI , MSG_ComposeType type , MSG_ComposeFormat format , nsIMsgIdentity identity , nsIMsgWindow msgWindow )

Arguments:
msgComposeWindowURL
originalMsgURI
type
format
identity
msgWindow

void OpenComposeWindowWithParams ( char* msgComposeWindowURL , nsIMsgComposeParams params )

Arguments:
msgComposeWindowURL
params

void OpenComposeWindowWithURI ( char* msgComposeWindowURL , nsIURI URI )

Arguments:
msgComposeWindowURL
URI

void registerComposeWindow ( nsIDOMWindowInternal window , nsIMsgCompose msgCompose )

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

Arguments:
window: The DOM Window
msgCompose: The compose object associated with the compose window

void replyWithTemplate ( nsIMsgDBHdr msgHdr , char* templateUri , nsIMsgWindow msgWindow , nsIMsgIncomingServer server )

Arguments:
msgHdr
templateUri
msgWindow
server

void TimeStamp ( char* label , PRBool resetTime )

Arguments:
label
resetTime

void unregisterComposeWindow ( nsIDOMWindowInternal window )

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

Arguments:
window: The DOM Window

Reference documentation is generated from Mozilla's source.