Back to index

lightning-sunbird  0.9+nobinonly
nsMailDatabase.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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) 1999
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 #ifndef _nsMailDatabase_H_
00039 #define _nsMailDatabase_H_
00040 
00041 #include "nsMsgDatabase.h"
00042 #include "nsMsgMessageFlags.h"
00043 
00044 // This is the subclass of nsMsgDatabase that handles local mail messages.
00045 class nsMsgKeyArray;
00046 class nsIOFileStream;
00047 class nsFileSpec;
00048 class nsOfflineImapOperation;
00049 
00050 class nsMailDatabase : public nsMsgDatabase
00051 {
00052 public:
00053   nsMailDatabase();
00054   virtual ~nsMailDatabase();
00055   NS_IMETHOD  Open(nsIFileSpec *aFolderName, PRBool create, PRBool upgrading);
00056   NS_IMETHOD  ForceClosed();
00057   NS_IMETHOD DeleteMessages(nsMsgKeyArray* nsMsgKeys, nsIDBChangeListener *instigator);
00058 
00059   NS_IMETHOD StartBatch();
00060   NS_IMETHOD EndBatch();
00061 
00062   static  nsresult        SetFolderInfoValid(nsFileSpec *folderSpec, int num, int numunread);
00063   nsresult                GetFolderName(nsString &folderName);
00064   virtual nsMailDatabase  *GetMailDB() {return this;}
00065 
00066   virtual PRUint32  GetCurVersion() {return kMsgDBVersion;}
00067   
00068   NS_IMETHOD  GetOfflineOpForKey(nsMsgKey opKey, PRBool create, nsIMsgOfflineImapOperation **op);
00069   NS_IMETHOD  RemoveOfflineOp(nsIMsgOfflineImapOperation *op);
00070 
00071   NS_IMETHOD  SetSummaryValid(PRBool valid);
00072   NS_IMETHOD  GetSummaryValid(PRBool *valid);
00073        
00074   NS_IMETHOD    EnumerateOfflineOps(nsISimpleEnumerator **enumerator);
00075   NS_IMETHOD    ListAllOfflineOpIds(nsMsgKeyArray *offlineOpIds);
00076   NS_IMETHOD    ListAllOfflineDeletes(nsMsgKeyArray *offlineDeletes);
00077 
00078   NS_IMETHOD SetFolderStream(nsIOFileStream *aFileStream);
00079   NS_IMETHOD GetFolderStream(nsIOFileStream **aFileStream);
00080 
00081   friend class nsMsgOfflineOpEnumerator;
00082 protected:
00083 
00084   nsresult        GetAllOfflineOpsTable(); // get this on demand
00085   PRUint32        GetMailboxModDate(); 
00086 
00087   nsCOMPtr <nsIMdbTable>  m_mdbAllOfflineOpsTable;
00088   mdb_token       m_offlineOpsRowScopeToken;
00089   mdb_token       m_offlineOpsTableKindToken;
00090 
00091   virtual PRBool  SetHdrFlag(nsIMsgDBHdr *, PRBool bSet, MsgFlags flag);
00092   virtual void    UpdateFolderFlag(nsIMsgDBHdr *msgHdr, PRBool bSet, 
00093                                     MsgFlags flag, nsIOFileStream **ppFileStream);
00094   virtual void    SetReparse(PRBool reparse);
00095   
00096 protected:
00097   virtual void    GetGlobalPrefs();
00098   
00099   PRBool          m_reparse;
00100   nsFileSpec    *m_folderSpec;
00101   nsIOFileStream  *m_folderStream;        /* this is a cache for loops which want file left open */
00102   PRBool          m_ownFolderStream; //if we are the owner of m_folderStream
00103 };
00104 
00105 #endif