Inherits From:nsILDAPAutoCompFormatter

An interface for formatter LDAP messages to be used as nsAutoCompleteItems for use in RFC 2822 message headers.


AString addressFormat

AString commentFormat

AString nameFormat

All three Format attributes are templates, which work as follows:

Required LDAP attributes are delimited by curly braces, and optional LDAP attributes are determined by brackets. Backslash escapes any character, including itself. Someday perhaps we'll rev this interface and change these to a more flexible format; perhaps something regexp based.

If any of these are unset, components implementing this interface are free to choose reasonable defaults. As an example, the "@mozilla.org/ldap-autocomplete-formatter;1?type=addrbook" implementation currently happens to use the following default strings:

NameFormat: "[cn]" addressFormat: "{mail}" commentFormat: ""

And generates autocomplete items like this:

Value: John Doe comment: Foo Organization

Note that nsILDAPAutoCompFormatter::getAttributes() is only required to be called by the nsILDAPAutoCompleteSession implementation when the nsILDAPAutoCompleteSession::formatter IDL attribute is set. So if for some reason the format attributes exposed through this interface get changed (eg a user changes their prefs), it is the changing code's responsibly to re-set the nsILDAPAutoCompleteSession::formatter IDL attribute to the same object to force a new getAttributes() call.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com