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.

nsIMsgCompose

IID:4e0bbbb8-4c9d-499e-ad8a-5e4c1866c0bb
Inherits From:nsIMsgSendListener

This interface is implemented by the following components:

Properties

PRBool bodyModified

readonly nsIMsgCompFields compFields

readonly PRBool composeHTML

PRBool deleteDraft

readonly nsIDOMWindowInternal domWindow

readonly nsIEditor editor

PRBool insertingQuotedContent

readonly nsIMsgSend messageSend

readonly char* originalMsgURI

readonly nsIMsgProgress progress

PRBool recycledWindow

nsIMsgComposeRecyclingListener recyclingListener

char* savedFolderURI

MSG_ComposeType type

readonly PRInt32 wrapLength

Methods

void abort ( ) void addMsgSendListener ( nsIMsgSendListener sendListener ) AUTF8String AttachmentPrettyName ( char* url , char* charset ) PRInt32 bodyConvertible ( ) [noscript] void buildBodyMessageAndSignature ( ) [noscript] void buildQuotedMessageAndSignature ( ) PRUint32 checkAndPopulateRecipients ( PRBool populateMailList , PRBool returnNonHTMLRecipients , out AString nonHTMLRecipients ) PRBool checkCharsetConversion ( nsIMsgIdentity identity , out char* fallbackCharset ) [noscript] void clearEditor ( ) void CloseWindow ( PRBool reclycleIt ) [noscript] void convertAndLoadComposeWindow ( nsStringRef prefix , nsStringRef buf , nsStringRef signature , PRBool quoted , PRBool HTMLEditor ) [noscript] void getQuotingToFollow ( out PRBool quotingToFollow ) void initEditor ( nsIEditor editor , nsIDOMWindow contentWindow ) void Initialize ( nsIDOMWindowInternal window , nsIMsgComposeParams params ) [noscript] void notifyStateListeners ( PRInt32 notificationType , nsresult result ) [noscript] void processReplyFlags ( ) [noscript] void processSignature ( nsIMsgIdentity identity , PRBool quoted , inout nsString msgBody ) void quoteMessage ( char* msgURI ) void RegisterStateListener ( nsIMsgComposeStateListener stateListener ) [noscript] void rememberQueuedDisposition ( ) void removeMsgSendListener ( nsIMsgSendListener sendListener ) void SendMsg ( MSG_DeliverMode deliverMode , nsIMsgIdentity identity , char* accountKey , nsIMsgWindow msgWindow , nsIMsgProgress progress ) [noscript] void setCiteReference ( nsString citeReference ) void SetDocumentCharset ( char* charset ) void SetSignature ( nsIMsgIdentity identity ) void UnregisterStateListener ( nsIMsgComposeStateListener stateListener )

void abort ( )

void addMsgSendListener ( nsIMsgSendListener sendListener )

Arguments:
sendListener

AUTF8String AttachmentPrettyName ( char* url , char* charset )

Arguments:
url
charset

PRInt32 bodyConvertible ( )

void buildBodyMessageAndSignature ( )

void buildQuotedMessageAndSignature ( )

PRUint32 checkAndPopulateRecipients ( PRBool populateMailList , PRBool returnNonHTMLRecipients , out AString nonHTMLRecipients )

CheckAndPopulateRecipients can perform several tasks (see params), the main task is to determine the lowest common format preferred by recipients.

Arguments:
populateMailList: If true, this function will populate mailing lists present in the compose field.
returnNonHTMLRecipients: If true, will build a list of the non HTML receipients.
nonHTMLRecipients: This will contain any non-HTML recipients, if returnNonHTMLRecipients is true (comma-separated).
Returns:
nsIAbPreferMailFormat.

PRBool checkCharsetConversion ( nsIMsgIdentity identity , out char* fallbackCharset )

Arguments:
identity
fallbackCharset

void clearEditor ( )

void CloseWindow ( PRBool reclycleIt )

Arguments:
reclycleIt

void convertAndLoadComposeWindow ( nsStringRef prefix , nsStringRef buf , nsStringRef signature , PRBool quoted , PRBool HTMLEditor )

Arguments:
prefix
buf
signature
quoted
HTMLEditor

void getQuotingToFollow ( out PRBool quotingToFollow )

Arguments:
quotingToFollow

void initEditor ( nsIEditor editor , nsIDOMWindow contentWindow )

Init the editor THIS USED TO BE [noscript] Now, this is called after editor is created, which is triggered by loading startup url from JS. The completion of document loading is detected by observing the "obs_documentCreated" command

Arguments:
editor
contentWindow

void Initialize ( nsIDOMWindowInternal window , nsIMsgComposeParams params )

Arguments:
window
params

void notifyStateListeners ( PRInt32 notificationType , nsresult result )

Arguments:
notificationType
result

void processReplyFlags ( )

void processSignature ( nsIMsgIdentity identity , PRBool quoted , inout nsString msgBody )

Arguments:
identity
quoted
msgBody

void quoteMessage ( char* msgURI )

Arguments:
msgURI

void RegisterStateListener ( nsIMsgComposeStateListener stateListener )

Arguments:
stateListener

void rememberQueuedDisposition ( )

void removeMsgSendListener ( nsIMsgSendListener sendListener )

Arguments:
sendListener

void SendMsg ( MSG_DeliverMode deliverMode , nsIMsgIdentity identity , char* accountKey , nsIMsgWindow msgWindow , nsIMsgProgress progress )

Arguments:
deliverMode
identity
accountKey
msgWindow
progress

void setCiteReference ( nsString citeReference )

Arguments:
citeReference

void SetDocumentCharset ( char* charset )

Arguments:
charset

void SetSignature ( nsIMsgIdentity identity )

Arguments:
identity

void UnregisterStateListener ( nsIMsgComposeStateListener stateListener )

Arguments:
stateListener

References

This interface is passed as an argument to the following methods:

nsIMsgComposeSendListener.setMsgCompose, nsIMsgComposeService.registerComposeWindow

This interface is returned from the following methods:

nsIMsgComposeService.InitCompose, nsIMsgComposeService.getMsgComposeForWindow

Reference documentation is generated from Mozilla's source.