Back to index

lightning-sunbird  0.9+nobinonly
nsINntpService.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  *   Seth Spitzer <sspitzer@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 #include "nsIUrlListener.idl"
00041 #include "nsINntpIncomingServer.idl"
00042 #include "MailNewsTypes2.idl"
00043 #include "nsIMsgIdentity.idl"
00044 
00045 interface nsIURI;
00046 interface nsIStreamListener;  
00047 interface nsISupportsArray;
00048 interface nsIFileSpec;
00049 interface nsIMsgWindow;
00050 interface nsIMsgFolder;
00051 interface nsICacheSession;
00052 
00053 [scriptable, uuid(4C9F90E0-E19B-11d2-806E-006008128C4E)]
00054 interface nsINntpService : nsISupports {
00055   
00056   /* newsgroupsList is a comma separated list of newsgroups, which may be
00057    * in news://host/group or group form
00058    * "news://host/group1,news://host/group2" or "group1,group2"
00059    *
00060    * newsgroupsHeaderVal is a comma separated list of groups in the group form
00061    * "group1,group2"
00062    *
00063    * newshostHeaderVal is a single hostname.
00064    * "host"
00065    */
00066   void generateNewsHeaderValsForPosting(in string newsgroupsList, out string newsgroupsHeaderVal, out string newshostHeaderVal);
00067 
00068   nsIURI postMessage(in nsIFileSpec fileToPost, in string newsgroupNames, in string aAccountKey, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow);
00069 
00070   nsIURI getNewNews(in nsINntpIncomingServer nntpServer, in string uri, in boolean getOld, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow);
00071 
00072   nsIURI cancelMessage(in string cancelURL, in string messageURI, in nsISupports aConsumer, in nsIUrlListener aUrlListener, in nsIMsgWindow aMsgWindow);
00073  
00074   void getListOfGroupsOnServer(in nsINntpIncomingServer nntpServer, in nsIMsgWindow aMsgWindow);
00075 
00076   void updateCounts(in nsINntpIncomingServer nntpServer, in nsIMsgWindow aMsgWindow);
00077 
00078   nsIURI fetchMessage(in nsIMsgFolder newsFolder, in nsMsgKey key, in nsIMsgWindow aMsgWindow, in nsISupports aConsumer, in nsIUrlListener aUrlListener);
00079 
00080   void downloadNewsgroupsForOffline(in nsIMsgWindow aMsgWindow, in nsIUrlListener aListener);
00084   void decomposeNewsURI(in string uri, out nsIMsgFolder folder, out nsMsgKey key);
00085 
00086   // handle to the cache session used by news....
00087   readonly attribute nsICacheSession cacheSession;
00088 };