Back to index

lightning-sunbird  0.9+nobinonly
nsIMailboxUrl.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) 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 "MailNewsTypes2.idl"
00040 #include "nsIFileSpec.idl"
00041 
00042 interface nsIStreamListener;
00043 interface nsIMsgDBHdr;
00044 %{C++
00045 #include "nsIStreamListener.h"
00046 %}
00047 
00048 typedef long nsMailboxAction;
00049 
00050 [scriptable, uuid(AE30B004-320C-4D2B-AB52-45D2C2DC2CCE)]
00051 interface nsIMailboxUrl : nsISupports {
00052 
00053        // Mailbox urls which parse a mailbox folder require a consumer of the
00054     // stream which will represent the mailbox. This consumer is the mailbox
00055     // parser. As data from the mailbox folder is read in, the data will be
00056     // written to a stream and the consumer will be notified through
00057     // nsIStreamListenter::OnDataAvailable that the stream has data
00058        // available...
00059        // mscott: I wonder if the caller should be allowed to create and set
00060     // the stream they want the data written to as well? Hmm....
00061        
00062     attribute nsIStreamListener mailboxParser;
00063     
00065        // Copy/Move mailbox urls require a mailbox copy handler which actually
00066     // performs the copy.
00068     attribute nsIStreamListener mailboxCopyHandler;
00069 
00070     // mailbox URL state
00071     [noscript] readonly attribute nsFileSpecPtr fileSpec;
00072 
00073     // Some mailbox urls include a message key for the message in question.
00074     readonly attribute nsMsgKey messageKey;
00075     
00076     // this is to support multiple msg move/copy in one url
00077     void setMoveCopyMsgKeys(out nsMsgKey keysToFlag, in long numKeys);
00078     void getMoveCopyMsgHdrForIndex(in unsigned long msgIndex, out nsIMsgDBHdr msgHdr);
00079     readonly attribute unsigned long numMoveCopyMsgs;
00080     attribute unsigned long curMoveCopyMsgIndex;
00081        // mailbox urls to fetch a mail message can specify the size of
00082     // the message...
00083        // this saves us the trouble of having to open up the msg db and ask
00084     // ourselves...
00085     attribute unsigned long messageSize;
00086     
00087     attribute nsMailboxAction mailboxAction;
00088 
00089     /* these are nsMailboxActions */
00090        const long ActionParseMailbox = 0;
00091     const long ActionFetchMessage = 1;
00092     const long ActionCopyMessage = 2;
00093        const long ActionMoveMessage = 3;
00094        const long ActionSaveMessageToDisk = 4;
00095        const long ActionAppendMessageToDisk = 5;
00096        const long ActionFetchPart = 6;
00097 };
00098