Revision control
Copy as Markdown
Other Tools
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
#include "nsISupports.idl"
/**
* nsIAbAddressCollector 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.
*/
[scriptable, uuid(069d3fba-37d4-4158-b401-a8efaeea0b66)]
interface nsIAbAddressCollector : nsISupports {
/**
* 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 aCreateCard
* is true.
*
* @param aAddresses The list of emails (in standard header format)
* to collect into the address book.
* @param aCreateCard Set to true if a card should be created if the
* email address doesn't exist.
*/
void collectAddress(in AUTF8String aAddresses, in boolean aCreateCard);
/**
* Collects a single name and email address into the address book.
* By default, it saves the address without checking for an existing one.
* See collectAddress for the general implementation.
*
* @param aEmail The email address to collect.
* @param aDisplayName The display name associated with the email address.
* @param aCreateCard Set to true if a card should be created if the
* email address doesn't exist (ignored if
* aSkipCheckExisting is true).
* @param aSkipCheckExisting Optional parameter, if this is set then the
* implementation will skip checking for an
* existing card, and just create a new card.
*/
void collectSingleAddress(in AUTF8String aEmail, in AUTF8String aDisplayName,
in boolean aCreateCard,
[optional] in boolean aSkipCheckExisting);
};