summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/base/public/nsIMailAuthModule.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /comm/mailnews/base/public/nsIMailAuthModule.idl
parentInitial commit. (diff)
downloadthunderbird-upstream.tar.xz
thunderbird-upstream.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--comm/mailnews/base/public/nsIMailAuthModule.idl40
1 files changed, 40 insertions, 0 deletions
diff --git a/comm/mailnews/base/public/nsIMailAuthModule.idl b/comm/mailnews/base/public/nsIMailAuthModule.idl
new file mode 100644
index 0000000000..83c0bdca0d
--- /dev/null
+++ b/comm/mailnews/base/public/nsIMailAuthModule.idl
@@ -0,0 +1,40 @@
+/* -*- Mode: IDL; 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"
+
+/**
+ * nsIAuthModule provides GSSAPI, NTLM authentications, but it is not
+ * scriptable. nsIMailAuthModule wraps nsIAuthModule and makes it easy to use in
+ * JavaScript.
+ *
+ * The contract id is: "@mozilla.org/mail/auth-module;1".
+ *
+ * @see nsIAuthModule
+ */
+[scriptable, uuid(9895e904-642e-11eb-bb69-6b87832ac976)]
+interface nsIMailAuthModule : nsISupports {
+
+ /**
+ * Initialize an auth module. This is a combination of
+ * nsIAuthModule::CreateInstance and nsIAuthModule::Init. The aType argument
+ * is passed to CreateInstance, other arguments are passed to Init.
+ */
+ void init(in string aType,
+ in ACString aServiceName,
+ in unsigned long aServiceFlags,
+ in AString aDomain,
+ in AString aUsername,
+ in AString aPassword);
+
+ /**
+ * Get the next token in a sequence of authentication steps.
+ * @param aInToken
+ * A base64 encoded string, usually a server challenge.
+ * @returns
+ * A base64 encoded string, usually a response to a server challenge.
+ */
+ ACString getNextToken(in ACString aInToken);
+};