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.

nsIAbAddressCollecter

IID:759cd643-e96b-4f31-883d-d9cf3d14f7c2
Inherits From:nsISupports

nsIAbAddressCollecter is the interface to the address collecter service. It will save and update the supplied addresses into the address book specified by the "mail.collect_addressbook" pref.

This interface is implemented by the following components:


Methods

void collectAddress ( AUTF8String addresses , PRBool createCard , PRUint32 sendFormat ) nsIAbCard getCardFromAttribute ( ACString name , ACString value )

void collectAddress ( AUTF8String addresses , PRBool createCard , PRUint32 sendFormat )

Collects email addresses into the address book. If a card already exists for the email, the first/last/display names will be updated if they are supplied alongside the address. If a card does not exist for the email it will be created if createCard is true.

Arguments:
addresses: The list of emails (in standard header format) to collect into the address book.
createCard: Set to true if a card should be created if the email address doesn't exist.
sendFormat: The send format to save for the card. See nsIAbPreferMailFormat for values. If updating a card this value will only be changed if the current value for the card is "unknown".

nsIAbCard getCardFromAttribute ( ACString name , ACString value )

Get the first card with this name / value in the collected ab.

Arguments:
name
value

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com