1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1999
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Seth Spitzer <sspitzer@netscape.com>
24 * Mark Banner <bugzilla@standard8.plus.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either of the GNU General Public License Version 2 or later (the "GPL"),
28 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40 #include "nsISupports.idl"
41
42 interface nsIAbCard;
43
44 /**
45 * nsIAbAddressCollecter is the interface to the address collecter service.
46 * It will save and update the supplied addresses into the address book
47 * specified by the "mail.collect_addressbook" pref.
48 */
49 [scriptable, uuid(759cd643-e96b-4f31-883d-d9cf3d14f7c2)]
50 interface nsIAbAddressCollecter : nsISupports {
51 /**
52 * Collects email addresses into the address book.
53 * If a card already exists for the email, the first/last/display names
54 * will be updated if they are supplied alongside the address.
55 * If a card does not exist for the email it will be created if aCreateCard
56 * is true.
57 *
58 * @param aAddresses The list of emails (in standard header format)
59 * to collect into the address book.
60 * @param aCreateCard Set to true if a card should be created if the
61 * email address doesn't exist.
62 * @param aSendFormat The send format to save for the card. See
63 * nsIAbPreferMailFormat for values. If updating a card
64 * this value will only be changed if the current value
65 * for the card is "unknown".
66 */
67 void collectAddress(in AUTF8String aAddresses, in boolean aCreateCard,
68 in unsigned long aSendFormat);
69
70 /**
71 * Get the first card with this name / value in the collected ab.
72 */
73 nsIAbCard getCardFromAttribute(in ACString aName, in ACString aValue);
74 };