RetroZilla/mailnews/addrbook/public/nsIAbLDIFService.idl
2015-10-20 23:03:22 -04:00

74 lines
3.0 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2005
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Mark Banner <bugzilla@standard8.demon.co.uk>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIFileSpec;
interface nsIAddrDatabase;
[scriptable, uuid(b594baf1-34d4-48ce-891c-66fc2e8bc59d)]
interface nsIAbLDIFService : nsISupports {
/**
* Determine if a file is likely to be an LDIF file based on field
* names that commonly appear in LDIF files.
*
* @param aSrc The file to examine
*
* @return PR_TRUE if the file appears to be of LDIF type,
* PR_FALSE otherwise
*/
boolean isLDIFFile(in nsIFileSpec aSrc);
/**
* Imports a file into the specified address book.
*
* @param aDb The address book to import addresses into.
*
* @param aSrc The file to import addresses from.
*
* @param aStoreLocAsHome Stores the address as a home rather than work
* address.
*
* @param aProgress May be null, but if a pointer is supplied,
* then it will be updated regularly with the
* current position of reading from the file.
*
*/
void importLDIFFile(in nsIAddrDatabase aDb, in nsIFileSpec aSrc, in boolean aStoreLocAsHome, inout unsigned long aProgress);
};