summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/mime/public/nsIPgpMimeProxy.idl
diff options
context:
space:
mode:
Diffstat (limited to 'comm/mailnews/mime/public/nsIPgpMimeProxy.idl')
-rw-r--r--comm/mailnews/mime/public/nsIPgpMimeProxy.idl90
1 files changed, 90 insertions, 0 deletions
diff --git a/comm/mailnews/mime/public/nsIPgpMimeProxy.idl b/comm/mailnews/mime/public/nsIPgpMimeProxy.idl
new file mode 100644
index 0000000000..cd581bf107
--- /dev/null
+++ b/comm/mailnews/mime/public/nsIPgpMimeProxy.idl
@@ -0,0 +1,90 @@
+/* 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 "nsIStreamListener.idl"
+#include "nsIURI.idl"
+
+%{C++
+typedef int (*MimeDecodeCallbackFun)(const char *buf, int32_t buf_size, void *output_closure);
+
+#define NS_PGPMIMEPROXY_CLASSNAME "PGP/Mime Decryption"
+#define NS_PGPMIMEPROXY_CONTRACTID "@mozilla.org/mime/pgp-mime-decrypt;1"
+
+#define NS_PGPMIMEPROXY_CID \
+{ /* 815c4fbe-0e7c-45b6-8324-f7044c7252ac */ \
+ 0x815c4fbe, 0x0e7c, 0x45b6, \
+{0x83, 0x24, 0xf0, 0x04, 0x4C, 0x72, 0x52, 0xac } }
+%}
+
+native MimeDecodeCallbackFun(MimeDecodeCallbackFun);
+
+/**
+ * nsIPgpMimeProxy is a proxy for a (JS-)addon for OpenPGP/MIME decryption
+ */
+
+[scriptable, uuid(815c4fbe-0e7c-45b6-8324-f7044c7252ac)]
+interface nsIPgpMimeProxy : nsIStreamListener
+{
+ /**
+ * set the decoder callback into mimelib
+ */
+ [noscript] void setMimeCallback(in MimeDecodeCallbackFun outputFun,
+ in voidPtr outputClosure,
+ in nsIURI myUri);
+
+ [noscript] void removeMimeCallback();
+
+ /**
+ * init function
+ */
+ void init();
+
+ /**
+ * process encoded data received from mimelib
+ */
+ void write(in string buf, in unsigned long count);
+
+ /**
+ * finish writing (EOF) from mimelib
+ */
+ void finish();
+
+ /**
+ * the listener that receives the OpenPGP/MIME data stream and decrypts
+ * the message
+ */
+ attribute nsIStreamListener decryptor;
+
+ attribute ACString contentType;
+
+ /**
+ * holds the URI of the message currently being processed
+ */
+ readonly attribute nsIURI messageURI;
+
+ /**
+ * The particular part number of the multipart object we are working on. The
+ * numbering is the same as in URLs that use the form "...?part=1.1.2".
+ *
+ * The value stored in mimePart is only the number, e.g. "1" or "1.1.2"
+ */
+ attribute ACString mimePart;
+
+ /**
+ * The application may restrict automatic decryption to the top level
+ * MIME part ("1"). In certain scenarios the application may allow
+ * a MIME part at another level ("nested") in the MIME tree to be
+ * decrypted, too. If the current MIME part is a nested MIME part,
+ * then this flag indicates whether automatic decryption is allowed.
+ */
+ attribute boolean allowNestedDecrypt;
+
+ /**
+ * Pass the decrypted data back from the decryptor and onto to libMime.
+ */
+ void outputDecryptedData(in string buf, in unsigned long count);
+};
+
+
+///////////////////////////////////////////////////////////////////////////////