summaryrefslogtreecommitdiffstats
path: root/mailnews/base/public/nsIMapiRegistry.idl
blob: a14f6242292c6ff8c7825f28ddccfb65ec28dc86 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/* 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
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface mozIDOMWindowProxy;

/**
 * This interface provides support for registering Mozilla as the default
 * Mail Client. This interface can also be used to get/set the user preference
 * for the default Mail Client.
 * 
 */

[scriptable, uuid(47D707C3-4369-46A6-A053-5118E12579D6)]
interface nsIMapiRegistry: nsISupports {

   /** This is set to TRUE if Mozilla is the default mail application
    */
   attribute boolean isDefaultMailClient;

   /* Set to TRUE if Mozilla is the default news application */
   attribute boolean isDefaultNewsClient;

   /* Set to TRUE if we are the default feed/rss application */
   attribute boolean isDefaultFeedClient;

   /** This is set TRUE only once per session.
    */
   readonly attribute boolean showDialog;

   /** This will bring the dialog asking the user if he/she wants to set
    * Mozilla as default Mail Client.
    * Call this only if Mozilla is not the default Mail client
    */
   void showMailIntegrationDialog(in mozIDOMWindowProxy parentWindow);

   /* After being installed, when we first launch, make sure we add the correct
    OS registry entries to make us show up as regsitered mail and news client
    in the OS
   */
   
   void registerMailAndNewsClient();
};

%{C++
#define NS_IMAPIREGISTRY_CONTRACTID    "@mozilla.org/mapiregistry;1"
#define NS_IMAPIREGISTRY_CLASSNAME "Mozilla MAPI Registry"
%}