summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/base/public/nsIMsgFolderCompactor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'comm/mailnews/base/public/nsIMsgFolderCompactor.idl')
-rw-r--r--comm/mailnews/base/public/nsIMsgFolderCompactor.idl34
1 files changed, 34 insertions, 0 deletions
diff --git a/comm/mailnews/base/public/nsIMsgFolderCompactor.idl b/comm/mailnews/base/public/nsIMsgFolderCompactor.idl
new file mode 100644
index 0000000000..96df873f32
--- /dev/null
+++ b/comm/mailnews/base/public/nsIMsgFolderCompactor.idl
@@ -0,0 +1,34 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* 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 nsIMsgFolder;
+interface nsIMsgWindow;
+interface nsIUrlListener;
+
+[scriptable, uuid(38c7e876-3083-4aea-8dcd-0ea0ec1753a3)]
+
+/**
+ * Use this for any object that wants to handle compacting folders.
+ * Currently, the folders themselves create this object.
+ */
+
+interface nsIMsgFolderCompactor : nsISupports
+{
+ /**
+ * Compact the passed in array of folders.
+ *
+ * @param folders The folders to compact.
+ * @param listener Notified of completion, can be null.
+ * OnStartRunningUrl() will not be called.
+ * OnStopRunningUrl() will be called upon
+ * completion, with a null URL.
+ * @param window Used for progress/status, can be null.
+ */
+ void compactFolders(in Array<nsIMsgFolder> folders,
+ in nsIUrlListener listener,
+ in nsIMsgWindow window);
+};