summaryrefslogtreecommitdiffstats
path: root/comm/mail/components/search/public/nsIMailWinSearchHelper.idl
blob: 1c1d03a07f4ef95cdcbbe28542d0e40e42690278 (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
51
52
53
54
55
56
57
58
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 nsIFile;

[scriptable, uuid(a65307b3-64f8-49fc-96a7-2cfc7d1f18ee)]
interface nsIMailWinSearchHelper : nsISupports
{
  /**
   * Whether the Windows Search service is installed and running.
   *
   * @exception NS_ERROR_NOT_AVAILABLE if the Windows Search service is
   * not installed
   */
  readonly attribute boolean serviceRunning;

  /**
   * Whether the Mail, ImapMail, and News folders are in the crawl scope.
   *
   * @exception NS_ERROR_NOT_AVAILABLE if the Windows Search service is not
   * installed or running
   */
  readonly attribute boolean foldersInCrawlScope;

  /**
   * Sets the File Attribute Not Content Indexed bit. For proper operation
   * of the indexer, this bit must be set to 0/false.
   *
   * @param aFile the file or directory for which this bit is supposed to be set
   * @param aBit false if the content is to be indexed, true if not
   * @param aRecurse whether this bit is to be set recursively for all subdirectories
   * and files inside a directory
   */
  void setFANCIBit(in nsIFile aFile, in boolean aBit, in boolean aRecurse);

  /**
   * Returns whether the .wdseml file association has been set to Thunderbird or not.
   */
  readonly attribute boolean isFileAssociationSet;

  /**
   * Sets the .wdseml file association.
   */
  void setFileAssociation();

  /**
   * Runs the setup application using ShellExecute, passing the profile directory as
   * a parameter.
   *
   * @param aEnable true to enable, false to disable
   */
  void runSetup(in boolean aEnable);
};