Back to index

lightning-sunbird  0.9+nobinonly
nsIDBFolderInfo.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 #include "nsISupports.idl"
00039 #include "MailNewsTypes2.idl"
00040 
00041 [scriptable, uuid(5cb11c00-cb8b-11d2-8d67-00805f8a6617)]
00042 interface  nsIDBFolderInfo : nsISupports {
00043   attribute long Flags;
00044   long  OrFlags(in long flags);
00045   long  AndFlags(in long flags);
00046   void  SetHighWater(in nsMsgKey highwater, in boolean force);
00047   attribute nsMsgKey HighWater;
00048   attribute nsMsgKey ExpiredMark;
00049   attribute unsigned long FolderSize;
00050   attribute unsigned long FolderDate;
00051   void ChangeNumUnreadMessages(in long delta);
00052   void ChangeNumMessages(in long delta);
00053 
00054   // NumUnreadMessages and NumMessages will never return negative numbers. 0 means 'no msgs'.
00055   attribute long NumUnreadMessages;
00056   attribute long NumMessages;
00057 
00058   attribute long expungedBytes;
00059   attribute long ImapUidValidity;
00060   attribute unsigned long Version;
00061   attribute long ImapTotalPendingMessages;
00062   attribute long ImapUnreadPendingMessages;
00063   attribute wchar IMAPHierarchySeparator;
00064 
00065   attribute nsMsgViewTypeValue viewType;
00066   attribute nsMsgViewFlagsTypeValue viewFlags;
00067   attribute nsMsgViewSortTypeValue sortType;
00068   attribute nsMsgViewSortOrderValue sortOrder;
00069 
00070   void ChangeExpungedBytes(in long delta);
00071 
00072   string getCharPtrProperty(in string propertyName);
00073   void setCharPtrProperty(in string aPropertyName, in string aPropertyValue);
00074   void setUint32Property(in string propertyName, in unsigned long propertyValue);
00075   unsigned long getUint32Property(in string propertyName, in unsigned long defaultValue);
00076   boolean getBooleanProperty(in string propertyName, in boolean defaultValue);
00077   void setBooleanProperty(in string propertyName, in boolean aPropertyValue);
00078   nsIDBFolderInfo    GetTransferInfo();
00079   void initFromTransferInfo(in nsIDBFolderInfo transferInfo);
00080 
00081   void getCharacterSet(out ACString charSet, out boolean overriden);
00082   void setCharacterSet(in string charSet);
00083 
00084   attribute boolean characterSetOverride;
00085 
00086   string getCharPtrCharacterSet();
00087 
00088   attribute AString locale;
00089   attribute AString mailboxName;
00090 
00091 
00092   AString getProperty(in string propertyName);
00093   void setProperty(in string propertyName, in AString propertyStr);
00094 
00095   attribute string knownArtsSet;
00096   attribute string folderName;
00097 };
00098 
00099