1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is mozilla.org code.
15 *
16 * The Initial Developer of the Original Code is
17 * Netscape Communications Corporation.
18 * Portions created by the Initial Developer are Copyright (C) 2002
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 * Srilatha Moturi <srilatha@netscape.com>
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsISupports.idl"
39 #include "nsILocalFile.idl"
40
41 /**
42 * This interface provides support for getting 4.x profile information
43 * This interface can be used to get the existing 4.x profiles
44 * and for getting the mail directory for the profile.
45 *
46 */
47 [scriptable, uuid(c66c1060-2bdc-11d6-92a0-0010a4b26cda)]
48 interface nsIComm4xProfile: nsISupports {
49 /**
50 * Parses the 4.x registry file and returns a list of profiles.
51 */
52
53 void getProfileList(out unsigned long length, [array, size_is(length), retval] out wstring selectList);
54
55 /**
56 * Searches the preferences file of the given profile for the pref mail.directory
57 * If the pref does not exist it, returns the default value.
58 * @param profileName name of the profile in the profiles array
59 * @return The path to the mail directory for the profile with the name profileName
60 *
61 */
62 wstring getMailDir(in wstring profileName);
63 };