Back to index

lightning-sunbird  0.9+nobinonly
nsISpamSettings.idl
Go to the documentation of this file.
00001 /* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 
00003 /* ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corp.
00020  * Portions created by the Initial Developer are Copyright (C) 2002
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Seth Spitzer <sspitzer@netscape.com>
00025  *   Dan Mosedale <dmose@netscape.com>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either the GNU General Public License Version 2 or later (the "GPL"), or
00029  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 
00042 #include "nsISupports.idl"
00043 
00044 interface nsIOutputStream;
00045 interface nsIMsgIncomingServer;
00046 interface nsIMsgDBHdr;
00047 interface nsIFile;
00048 
00049 [scriptable, uuid(60BF2B22-AA8C-4cb2-80C8-ADC8B508E425)]
00050 interface nsISpamSettings: nsISupports {
00054   attribute long level; 
00055 
00056   attribute boolean moveOnSpam;
00057   readonly attribute boolean markAsReadOnSpam;
00058 
00063   attribute long moveTargetMode;
00064   const long MOVE_TARGET_MODE_ACCOUNT = 0;
00065   const long MOVE_TARGET_MODE_FOLDER = 1;
00066   attribute string actionTargetAccount;
00067   attribute string actionTargetFolder;
00068 
00072   readonly attribute string spamFolderURI;
00073 
00074   attribute boolean purge;
00078   attribute long purgeInterval;
00079 
00080   attribute boolean useWhiteList;
00081   attribute string whiteListAbURI;
00082 
00087   readonly attribute boolean manualMark;
00088   readonly attribute long manualMarkMode;
00089   const long MANUAL_MARK_MODE_MOVE = 0;
00090   const long MANUAL_MARK_MODE_DELETE = 1;
00091 
00095   attribute boolean useServerFilter;
00096   attribute ACString serverFilterName;
00097   readonly attribute nsIFile serverFilterFile;
00098   const long TRUST_POSITIVES = 1;
00099   const long TRUST_NEGATIVES = 2;
00100   attribute long serverFilterTrustFlags;
00101 
00102   // for logging
00103   readonly attribute boolean loggingEnabled;
00104   attribute nsIOutputStream logStream;
00105   void logJunkHit(in nsIMsgDBHdr aMsgHdr, in boolean aMoveMessage);
00106   void logJunkString(in string aLogText);
00107   void clone(in nsISpamSettings aSpamSettings); 
00108 
00109   // aServer -> spam settings are associated with a particular server
00110   void initialize(in nsIMsgIncomingServer aServer);
00111 };