nsIAbAddressCollecter Interface Reference

import "nsIAbAddressCollecter.idl";

Inheritance diagram for nsIAbAddressCollecter:

[legend]

Collaboration diagram for nsIAbAddressCollecter:

[legend]

List of all members.

---

Detailed Description

It will save and update the supplied addresses into the address book specified by the "mail.collect_addressbook" pref.

Public Member Functions
void	collectAddress (in AUTF8String aAddresses, in boolean aCreateCard, in unsigned long aSendFormat)
	Collects email addresses into the address book.
nsIAbCard	getCardFromAttribute (in ACString aName, in ACString aValue)
	Get the first card with this name / value in the collected ab.

---

Member Function Documentation

void nsIAbAddressCollecter::collectAddress	(	in AUTF8String	aAddresses,
		in boolean	aCreateCard,
		in unsigned long	aSendFormat
	)

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 aCreateCard is true.

Parameters:

	aAddresses	The list of emails (in standard header format) to collect into the address book.
	aCreateCard	Set to true if a card should be created if the email address doesn't exist.
	aSendFormat	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 nsIAbAddressCollecter::getCardFromAttribute	(	in ACString	aName,
		in ACString	aValue
	)

---

The documentation for this interface was generated from the following file:

• mailnews/addrbook/public/nsIAbAddressCollecter.idl