Back to index

lightning-sunbird  0.9+nobinonly
nsIImapIncomingServer.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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) 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 
00040 interface nsIUrlListener;
00041 interface nsIURI;
00042 interface nsIImapUrl;
00043 interface nsIEventQueue;
00044 interface nsIImapProtocol;
00045 interface nsISupportsArray;
00046 interface nsIMsgFolder;
00047 interface nsIMsgWindow;
00048 
00049 typedef long nsMsgImapDeleteModel;
00050 
00051 [scriptable, uuid(bbfc33de-fe89-11d3-a564-0060b0fc04b7)]
00052 interface nsMsgImapDeleteModels
00053 {
00054        const long IMAPDelete = 0;  /* delete with a big red x */
00055        const long MoveToTrash = 1; /* delete moves message to the trash */
00056        const long DeleteNoTrash = 2; /* delete is shift delete - don't create or use trash */
00057 };
00058 
00059 [scriptable, uuid(e2edee9e-5660-46d5-965b-b824cc81a335)]
00060 interface nsIImapIncomingServer : nsISupports {
00061 
00062   attribute long maximumConnectionsNumber;
00063   attribute long timeOutLimits;
00064   attribute string adminUrl;
00065   attribute string serverDirectory;
00066   attribute long capabilityPref;
00067   attribute boolean cleanupInboxOnExit;
00068   attribute nsMsgImapDeleteModel deleteModel;
00069   attribute boolean dualUseFolders;
00070   attribute long emptyTrashThreshhold;
00071   attribute string personalNamespace;
00072   attribute string publicNamespace;
00073   attribute string otherUsersNamespace;
00074   attribute boolean offlineDownload;
00075   attribute boolean overrideNamespaces;
00076   attribute boolean usingSubscription;
00077   attribute string manageMailAccountUrl;
00078   attribute boolean fetchByChunks;
00079   attribute boolean mimePartsOnDemand;
00080   attribute boolean isAOLServer;       
00081   attribute boolean aOLMailboxView;
00082   attribute boolean storeReadMailInPFC;
00083   attribute boolean storeSentMailInPFC;
00084   attribute boolean useIdle;
00085   attribute wstring trashFolderName;
00086 
00087   boolean getIsPFC(in string folderName);
00088   nsIMsgFolder getPFC(in boolean createIfMissing);
00089   attribute boolean downloadBodiesOnGetNewMail;
00090   attribute boolean autoSyncOfflineStores;
00091   void GetImapConnectionAndLoadUrl(in nsIEventQueue aClientEventQueue,
00092                                            in nsIImapUrl aImapUrl,
00093                                            in nsISupports aConsumer);
00094 
00095   void RemoveConnection(in nsIImapProtocol aImapConnection);
00096   void ResetNamespaceReferences();
00097   void pseudoInterruptMsgLoad(in nsIMsgFolder aImapFolder, in nsIMsgWindow aMsgWindow, out boolean interrupted);
00098   void ResetConnection(in string folderName);
00099   void CloseConnectionForFolder(in nsIMsgFolder aMsgFolder);
00100   void reDiscoverAllFolders();
00101   nsIURI subscribeToFolder(in wstring name, in boolean subscribe);
00102   nsIMsgFolder GetReadMailPFC(in boolean createIfMissing);
00103   nsIMsgFolder GetSentMailPFC(in boolean createIfMissing);
00104   void GetNewMessagesForNonInboxFolders(in nsIMsgFolder aRootFolder,
00105                                         in nsIMsgWindow aWindow,
00106                                         in boolean forceAllFolders,
00107                                         in boolean performingBiff);
00108   attribute boolean doingLsub;
00109   void allowFolderConversion(out boolean allowConversion);
00110   void convertFolderName(in string originalName, out wstring convertedName);
00111   void hideFolderName(in string originalName, out boolean hideFolder);
00112   string getTrashFolderByRedirectorType();
00113   attribute string redirectorType;
00114 
00115   string getUriWithNamespacePrefixIfNecessary(in long namespaceType, in string originalUri);
00116   attribute boolean shuttingDown;
00117 };