Back to index

lightning-sunbird  0.9+nobinonly
nsIImapMessageSink.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 #include "nsIImapUrl.idl"
00041 
00042 interface nsIFileSpec;
00043 interface nsIMsgMailNewsUrl;
00044 
00045 [scriptable, uuid(b92c9161-2345-4adb-af90-5a42cd898209)]
00046 
00047 interface nsIImapMessageSink : nsISupports {
00048     // set up messge download output stream
00049 //    void SetupMsgWriteStream(in nsIFileSpec aFileSpec, in boolean appendDummyEnvelope);
00050        void SetupMsgWriteStream(in string aNativePath, in boolean appendDummyEnvelope);
00051 
00052     void ParseAdoptedMsgLine(in string adoptedMsgLine, in nsMsgKey uidOfMsg);
00053     
00054     void normalEndMsgWriteStream(in nsMsgKey uidOfMessage, in boolean markMsgRead, in nsIImapUrl imapUrl);
00055     
00056     void AbortMsgWriteStream();
00057 
00058   attribute boolean notifyDownloadedLines;  // imap protocol doesn't notify message sink of downloaded
00059                                   // lines when it has a channelListener. This forces it to,
00060                                   // even if there is a channel listener.
00061     // message move/copy related methods
00062 //    void OnlineCopyReport(in ImapOnlineCopyState aCopyState);
00063     void BeginMessageUpload();
00064 //    void UploadMessageFile(UploadMessageInfo* aMsgInfo);
00065 
00066     // message flags operation
00067     void NotifyMessageFlags(in unsigned long flags, in nsMsgKey messageKey);
00068 
00069     void NotifyMessageDeleted(in string onlineFolderName,in boolean deleteAllMsgs,in string msgIdString);
00070 
00071     void GetMessageSizeFromDB(in string id, in boolean idIsUid, out unsigned long size);
00072 
00073     void SetContentModified(in nsIImapUrl aImapUrl, in nsImapContentModifiedType modified);
00074     void SetImageCacheSessionForUrl(in nsIMsgMailNewsUrl aMailUrl);
00075     
00076     unsigned long getCurMoveCopyMessageInfo(in nsIImapUrl runningUrl, 
00077                                             out PRTime date, out string keywords);
00078 };