Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgLocalMailFolder.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 #include "nsISupportsArray.idl"
00040 interface nsIMsgWindow;
00041 interface nsIUrlListener;
00042 interface nsIMsgDatabase;
00043 interface nsIMsgDBHdr;
00044 interface nsIMsgFolder;
00045 interface nsIMsgCopyServiceListener;
00046 
00047 [ptr] native nsLocalFolderScanState(nsLocalFolderScanState);
00048 
00049 %{C++
00050 /* flags for markMsgsOnPop3Server */
00051 #define POP3_NONE    0
00052 #define POP3_DELETE  1
00053 #define POP3_FETCH_BODY     2
00054 #define POP3_FORCE_DEL      3
00055 
00056 struct nsLocalFolderScanState;
00057 
00058 %}
00059 
00060 [scriptable, uuid(260398bd-9152-4b10-af4e-3126dcd37837)]
00061 interface nsIMsgLocalMailFolder : nsISupports {
00069   void setFlagsOnDefaultMailboxes(in unsigned long flags);
00070 
00071   /* 
00072    * This will return null if the db is out of date
00073    */
00074   nsIMsgDatabase getDatabaseWOReparse();
00075 
00076   /*
00077    * This will kick off a url to reparse the db if it's out of date.
00078    * If aReparseUrlListener isn ull, folder will use itself as the listener
00079    */
00080   nsIMsgDatabase getDatabaseWithReparse(in nsIUrlListener aReparseUrlListener, in nsIMsgWindow aMsgWindow);
00081   void parseFolder(in nsIMsgWindow aMsgWindow, in nsIUrlListener listener);
00082   void copyFolderLocal(in nsIMsgFolder srcFolder, in boolean isMove, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener );
00083   void copyAllSubFolders(in nsIMsgFolder srcFolder, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener );
00084   void onCopyCompleted(in nsISupports aSrcSupport, in boolean aMoveCopySucceeded);
00085   attribute boolean checkForNewMessagesAfterParsing;
00086   [noscript] void markMsgsOnPop3Server(in nsISupportsArray aMessages, in PRInt32 aMark);
00087   void refreshSizeOnDisk(); // file size on disk has possibly changed - update and notify
00088 
00089   // this adds a message to the end of the folder, parsing it as it goes, and
00090   // applying filters, if applicable.
00091   void addMessage(in string aMessage);
00097   void deleteDownloadMsg(in nsIMsgDBHdr aMsgHdr, out boolean aDoSelect);
00098   void selectDownloadMsg();
00099   void notifyDelete();
00100 
00105   [noscript] void getFolderScanState(in nsLocalFolderScanState aState);
00106   [noscript] void getUidlFromFolder(in nsLocalFolderScanState aState, in nsIMsgDBHdr aMsgHdr);
00107 
00108   boolean warnIfLocalFileTooBig(in nsIMsgWindow aWindow);
00109 };