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) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
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
40 /*
41 * The mail session is a replacement for the old 4.x MSG_Master object. It
42 * contains mail session generic information such as the account manager, etc
43 * I'm starting this off as an empty interface and as people feel they need to
44 * add more information to it, they can. I think this is a better approach
45 * than trying to port over the old MSG_Master in its entirety as that had a
46 * lot of cruft in it....
47 */
48
49 #include "nsISupports.idl"
50 #include "nsIFolderListener.idl"
51 #include "nsIMsgWindow.idl"
52 #include "nsIAtom.idl"
53
54 interface nsIFile;
55
56 [scriptable, uuid(11fd2852-d7f3-402c-9d2b-6dd206e7e8cd)]
57 interface nsIMsgMailSession : nsISupports {
58 void Shutdown();
59
60 /**
61 * Adds a listener to be notified when folders update.
62 *
63 * @param aListener The listener to add.
64 * @param aNotifyFlags A combination of flags detailing on which operations
65 * to notify the listener. See nsIFolderListener.idl for
66 * details.
67 */
68 void AddFolderListener(in nsIFolderListener aListener,
69 in folderListenerNotifyFlagValue aNotifyFlags);
70 /**
71 * Removes a listener from the folder notification list.
72 *
73 * @param aListener The listener to remove.
74 */
75 void RemoveFolderListener(in nsIFolderListener aListener);
76
77 readonly attribute nsIMsgWindow topmostMsgWindow;
78 void AddMsgWindow(in nsIMsgWindow msgWindow);
79 void RemoveMsgWindow(in nsIMsgWindow msgWindow);
80 boolean IsFolderOpenInWindow(in nsIMsgFolder folder);
81
82 string ConvertMsgURIToMsgURL(in string aURI, in nsIMsgWindow aMsgWindow);
83 nsIFile getDataFilesDir(in string dirName);
84 };