summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/compose/public/nsIMsgCopy.idl
diff options
context:
space:
mode:
Diffstat (limited to 'comm/mailnews/compose/public/nsIMsgCopy.idl')
-rw-r--r--comm/mailnews/compose/public/nsIMsgCopy.idl38
1 files changed, 38 insertions, 0 deletions
diff --git a/comm/mailnews/compose/public/nsIMsgCopy.idl b/comm/mailnews/compose/public/nsIMsgCopy.idl
new file mode 100644
index 0000000000..338e7234de
--- /dev/null
+++ b/comm/mailnews/compose/public/nsIMsgCopy.idl
@@ -0,0 +1,38 @@
+/* -*- 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"
+#include "nsIMsgFolder.idl"
+#include "nsIMsgIdentity.idl"
+#include "nsIMsgSend.idl"
+
+/**
+ * The contract ID for this component is @mozilla.org/messengercompose/msgcopy;1.
+ */
+[scriptable, uuid(de03b16f-3a41-40d0-a487-ca21abcf2bee)]
+interface nsIMsgCopy : nsISupports {
+ /**
+ * Start the process of copying a message file to a message folder. The
+ * destinationfolder depends on pref and deliver mode.
+ *
+ * @param aUserIdentity The identity of the sender
+ * @param aFile The message file
+ * @param aMode The deliver mode
+ * @param aMsgSendObj The nsIMsgSend instance that listens to copy events
+ * @param aSavePref The folder uri on server
+ * @param aMsgToReplace The message to replace when copying
+ */
+ void startCopyOperation(in nsIMsgIdentity aUserIdentity,
+ in nsIFile aFile,
+ in nsMsgDeliverMode aMode,
+ in nsIMsgSend aMsgSendObj,
+ in AUTF8String aSavePref,
+ in nsIMsgDBHdr aMsgToReplace);
+
+ /**
+ * Destination folder of the copy operation. Used when aborting copy operation.
+ */
+ readonly attribute nsIMsgFolder dstFolder;
+};