nsIEditorMailSupport

Provides simple editing actions for the Thunderbird mail editor.
Inherits from: nsISupports Last changed in Gecko 1.7

Method overview

nsISupportsArray getEmbeddedObjects();
nsIDOMNode insertAsCitedQuotation(in AString aQuotedText, in AString aCitation, in boolean aInsertHTML);
nsIDOMNode insertAsQuotation(in AString aQuotedText);
void insertTextWithQuotations(in DOMString aStringToInsert);
void pasteAsCitedQuotation(in AString aCitation, in long aSelectionType);
void pasteAsQuotation(in long aSelectionType);
void rewrap(in boolean aRespectNewlines);
void stripCites();

Methods

getEmbeddedObjects()

Get a list of IMG and OBJECT tags in the current document.

nsISupportsArray getEmbeddedObjects();
Parameters

None.

Return value

An nsISupportsArray containing the IMG and OBJECT tags of the current document.

insertAsCitedQuotation()

Insert a string as quoted text (whose representation is dependent on the editor type), replacing the selected text (if any), including, if possible, a "cite" attribute.

nsIDOMNode insertAsCitedQuotation(
  in AString aQuotedText,
  in AString aCitation,
  in boolean aInsertHTML
);
Parameters
aQuotedText
The actual text to be quoted.
aCitation
The "mid" URL of the source message.
aInsertHTML
Insert as html? (vs plaintext)
Return value

The nsIDOMNode which was inserted.

insertAsQuotation()

Insert a string as quoted text (whose representation is dependent on the editor type), replacing the selected text (if any).

nsIDOMNode insertAsQuotation(
  in AString aQuotedText
);
Parameters
aQuotedText
The actual text to be quoted.
Return value

The nsIDOMNode which was inserted.

insertTextWithQuotations()

Inserts a plain text string at the current location, with special processing for lines beginning with ">", which will be treated as mail quotes and inserted as plain text quoted blocks. If the selection is not collapsed, the selection is deleted and the insertion takes place at the resulting collapsed selection.

void insertTextWithQuotations(
  in DOMString aStringToInsert
);
Parameters
aStringToInsert
The string to be inserted

pasteAsCitedQuotation()

Paste a string as quoted text, whose representation is dependent on the editor type, replacing the selected text (if any)

void pasteAsCitedQuotation(
  in AString aCitation,
  in long aSelectionType
);
Parameters
aCitation
The "mid" URL of the source message.
aSelectionType
Text or html?

pasteAsQuotation()

Paste the text in the OS clipboard at the cursor position, as a quotation (whose representation is dependent on the editor type), replacing the selected text (if any).

void pasteAsQuotation(
  in long aSelectionType
);
Parameters
aSelectionType
Text or html?

rewrap()

Rewrap the selected part of the document, re-quoting if necessary.

void rewrap(
  in boolean aRespectNewlines
);
Parameters
aRespectNewlines
Try to maintain newlines in the original?

stripCites()

Strip any citations in the selected part of the document.

void stripCites();
Parameters

None.

Document Tags and Contributors

Contributors to this page: Sheppy, Cancerbero sgx, trevorh
Last updated by: Sheppy,