nsIMsgAccountManagerExtension

The nsIMsgAccountManagerExtension interface is used to add a new panel to Thunderbird's Account Manager.

An Account Manager Extension is a XPCOM compontent implementing this Interface. The interface is basically a manifest and defines the properties of the new Panel. A Panel consists of a XUL file with a Page Element as root element and the Property File containing the localized name.

Note:  The Account Manager relies on a very strong naming scheme to load and unload a panel. An Account Manager Extension with a "name" attribute of "devmo" and the "chromePackageName" attribute set to "extension@example.org" means, that the Account Manager expects to find a XUL file in "chrome://extension@example.org/content/am-devmo.xul" and a property file in "chrome://extension@example.org/locale/am-devmo.properties" containing a property named "prefPanel-devmo".

You have to register any new Account Manager Extensions via the the category manager at start up. Simply add a new Entry with the Contact ID of the component to the "mailnews-accountmanager-extensions" category.


Please add a summary to this article.
  Last changed in Gecko ???

Inherits from: nsISupports

Method overview

boolean showPanel(in nsIMsgIncomingServer server);

Attributes

Attribute Type Description
name ACString name of the account manager extension. It has to be unique and defines the file name of the property file and the XUL Page as well as the name of the localized string contained in the property file. This attribute is readonly!
chromePackageName ACString chrome package, where the files for the new panel are located. This is usually GUID of the ID of the addons which adds the new Panel. This attribute is readonly!

Methods

showPanel()

Before displaying a panel in the Account Manager this method is triggered.

 boolean showPanel(
   in nsIMsgIncomingServer server
 );
Parameters
server
The account for which the panel should be displayed.
Return value

A true indicates, that the Account Manager can display the panel for the given account, while false prevents the panel to be loaded.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, Smi
Last updated by: Sheppy,