summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/search/src/nsMsgFilter.h
diff options
context:
space:
mode:
Diffstat (limited to 'comm/mailnews/search/src/nsMsgFilter.h')
-rw-r--r--comm/mailnews/search/src/nsMsgFilter.h100
1 files changed, 100 insertions, 0 deletions
diff --git a/comm/mailnews/search/src/nsMsgFilter.h b/comm/mailnews/search/src/nsMsgFilter.h
new file mode 100644
index 0000000000..bf77f7a992
--- /dev/null
+++ b/comm/mailnews/search/src/nsMsgFilter.h
@@ -0,0 +1,100 @@
+/* -*- Mode: C++; 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/. */
+
+#ifndef _nsMsgFilter_H_
+#define _nsMsgFilter_H_
+
+#include "nscore.h"
+#include "nsISupports.h"
+#include "nsIMsgFilter.h"
+#include "nsIMsgSearchScopeTerm.h"
+#include "nsMsgSearchBoolExpression.h"
+#include "nsIMsgFilterCustomAction.h"
+
+class nsMsgRuleAction : public nsIMsgRuleAction {
+ public:
+ NS_DECL_ISUPPORTS
+
+ nsMsgRuleAction();
+
+ NS_DECL_NSIMSGRULEACTION
+
+ private:
+ virtual ~nsMsgRuleAction();
+
+ nsMsgRuleActionType m_type;
+ // this used to be a union - why bother?
+ nsMsgPriorityValue m_priority; /* priority to set rule to */
+ nsCString m_folderUri;
+ int32_t m_junkScore; /* junk score (or arbitrary int value?) */
+ // arbitrary string value. Currently, email address to forward to
+ nsCString m_strValue;
+ nsCString m_customId;
+ nsCOMPtr<nsIMsgFilterCustomAction> m_customAction;
+};
+
+class nsMsgFilter : public nsIMsgFilter {
+ public:
+ NS_DECL_ISUPPORTS
+
+ nsMsgFilter();
+
+ NS_DECL_NSIMSGFILTER
+
+ nsMsgFilterTypeType GetType() { return m_type; }
+ void SetType(nsMsgFilterTypeType type) { m_type = type; }
+ bool GetEnabled() { return m_enabled; }
+ void SetFilterScript(nsCString* filterName);
+
+ bool IsScript() {
+ return (m_type & (nsMsgFilterType::InboxJavaScript |
+ nsMsgFilterType::NewsJavaScript)) != 0;
+ }
+
+ // filing routines.
+ nsresult SaveRule(nsIOutputStream* aStream);
+
+ int16_t GetVersion();
+#ifdef DEBUG
+ void Dump();
+#endif
+
+ nsresult ConvertMoveOrCopyToFolderValue(nsIMsgRuleAction* filterAction,
+ nsCString& relativePath);
+ static const char* GetActionStr(nsMsgRuleActionType action);
+ static nsresult GetActionFilingStr(nsMsgRuleActionType action,
+ nsCString& actionStr);
+ static nsMsgRuleActionType GetActionForFilingStr(nsCString& actionStr);
+
+ protected:
+ /*
+ * Reporting function for filtering success/failure.
+ * Logging has to be enabled for the message to appear.
+ */
+ nsresult LogRuleHitGeneric(nsIMsgRuleAction* aFilterAction,
+ nsIMsgDBHdr* aMsgHdr, nsresult aRcode,
+ const nsACString& aErrmsg);
+
+ virtual ~nsMsgFilter();
+
+ nsMsgFilterTypeType m_type;
+ nsString m_filterName;
+ nsCString m_scriptFileName; // iff this filter is a script.
+ nsCString m_description;
+ nsCString m_unparsedBuffer;
+
+ bool m_enabled;
+ bool m_temporary;
+ bool m_unparseable;
+ nsIMsgFilterList* m_filterList; /* owning filter list */
+ nsTArray<RefPtr<nsIMsgSearchTerm>> m_termList; /* criteria terms */
+ nsCOMPtr<nsIMsgSearchScopeTerm>
+ m_scope; /* default for mail rules is inbox, but news rules could
+ have a newsgroup - LDAP would be invalid */
+ nsTArray<nsCOMPtr<nsIMsgRuleAction>> m_actionList;
+ nsMsgSearchBoolExpression* m_expressionTree;
+};
+
+#endif