1 files changed, 74 insertions, 0 deletions
diff --git a/comm/mailnews/base/public/nsISubscribableServer.idl b/comm/mailnews/base/public/nsISubscribableServer.idl
new file mode 100644
index 0000000000..70b0d980db
--- /dev/null
+++ b/comm/mailnews/base/public/nsISubscribableServer.idl
@@ -0,0 +1,74 @@
+/* -*- Mode: IDL; tab-width: 4; 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 nsIMsgWindow;
+interface nsIMsgIncomingServer;
+interface nsITreeView;
+interface nsIUTF8StringEnumerator;
+
+/**
+ * A listener to receive notification of the subscribable folders of a server.
+ */
+[scriptable, uuid(f337b84a-1dd1-11b2-97c7-fb8b2e3f2280)]
+interface nsISubscribeListener : nsISupports {
+  /**
+   * The server has finished finding all folders to subscribe to.
+   */
+  void OnDonePopulating();
+};
+
+[scriptable, uuid(14b8597a-755b-4e93-b364-e0903801e6ea)]
+interface nsISubscribableServer : nsISupports {
+  attribute nsISubscribeListener subscribeListener;
+  attribute char delimiter;
+
+  void startPopulating(in nsIMsgWindow aMsgWindow, in boolean forceToServer, in boolean getOnlyNew);
+  void startPopulatingWithUri(in nsIMsgWindow aMsgWindow, in boolean forceToServer, in AUTF8String uri);
+  void stopPopulating(in nsIMsgWindow aMsgWindow);
+
+  // return true if state changed, false otherwise
+  boolean setState(in AUTF8String path, in boolean state);
+
+  void subscribeCleanup();
+
+  void subscribe(in wstring name);
+  void unsubscribe(in wstring name);
+
+    void commitSubscribeChanges();
+
+    // other stuff
+  void setIncomingServer(in nsIMsgIncomingServer server);
+  void addTo(in AUTF8String aName, in boolean addAsSubscribed,
+            in boolean aSubscribable, in boolean aChangeIfExists);
+  void setAsSubscribed(in AUTF8String path);
+  void updateSubscribed();
+  void setShowFullName(in boolean showFullName);
+
+  // if path is null, use the root
+  boolean hasChildren(in AUTF8String path);
+  // if path is null, use the root
+  boolean isSubscribed(in AUTF8String path);
+  // if path is null, use the root
+  boolean isSubscribable(in AUTF8String path);
+  // if path is null, use the root
+  AString getLeafName(in AUTF8String path);
+
+  /**
+   * Returns the children uris underneath the specified uri (path).
+   *
+   * @param  aPath  The server's uri; If this is null or empty, then the
+   *                root server uri will be used.
+   */
+  Array<AUTF8String> getChildURIs(in AUTF8String aPath);
+  // if path is null, use the root
+  AUTF8String getFirstChildURI(in AUTF8String path);
+
+  // for searching
+  void setSearchValue(in AString searchValue);
+  readonly attribute boolean supportsSubscribeSearch;
+  readonly attribute nsITreeView folderView;
+};