Back to index

lightning-sunbird  0.9+nobinonly
nsIMailboxService.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 "nsIUrlListener.idl"
00040 
00041 interface nsIURI;
00042 interface nsIStreamListener;
00043 interface nsIMsgWindow;
00044 
00045 [ref] native nsFileSpec(nsFileSpec);
00046 
00047 %{C++
00048 #include "nsFileSpec.h"
00049 %}
00050 
00051 [scriptable, uuid(EEF82460-CB69-11d2-8065-006008128C4E)]
00052 interface nsIMailboxService : nsISupports {
00053 
00054   /*
00055    * All of these functions build mailbox urls and run them. If you want a
00056    * handle on the running task, pass in a valid nsIURI ptr. You can later
00057    * interrupt this action by asking the netlib service manager to interrupt
00058    * the url you are given back. Remember to release aURL when you are done
00059    * with it. Pass nsnull in for aURL if you don't care about the returned URL.
00060    */
00061        
00062   /*
00063    * Pass in a file path for the mailbox you wish to parse. You also need to
00064    * pass in a mailbox  parser (the consumer). The url listener can be null
00065    * if you have no interest in tracking the url.
00066    */
00067   [noscript] nsIURI ParseMailbox(in nsIMsgWindow aMsgWindow, in nsFileSpec aMailboxPath,
00068                                  in nsIStreamListener aMailboxParser,
00069                                  in nsIUrlListener aUrlListener);
00070 
00071 };