Back to index

lightning-sunbird  0.9+nobinonly
nsIPop3Service.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 #include "nsIPop3IncomingServer.idl"
00041 #include "nsIMsgFolder.idl"
00042 
00043 interface nsIURI;
00044 interface nsIStreamListener;
00045 interface nsIMsgWindow;
00046 interface nsIMsgFolder;
00047 /*
00048  * The Pop3 Service is an interface designed to make building and running
00049  * pop3 urls easier. I'm not sure if this service will go away when the
00050  * new networking model comes on line (as part of the N2 project). So
00051  * I reserve the right to change my mind and take this service away =).
00052  */
00053 [scriptable, uuid(3BB459E0-D746-11d2-806A-006008128C4E)]
00054 interface nsIPop3Service : nsISupports {
00055   /*
00056    * All of these functions build pop3 urls and run them. If you want
00057    * a handle on the running task, pass in a valid nsIURI ptr. You can later
00058    * interrupt this action by asking the netlib service manager to interrupt
00059    * the url you are given back. Remember to release aURL when you are
00060    * done with it. Pass nsnull in for aURL if you
00061    * don't care about the returned URL.
00062    */
00063 
00064   /*
00065    * right now getting new mail doesn't require any user specific data.
00066    * We use the default current identity for this information. I suspect that
00067    * we'll eventually pass in an identity to this call so you can get
00068    * mail on different pop3 accounts....
00069    */
00070   
00071   nsIURI GetNewMail(in nsIMsgWindow aMsgWindow, in nsIUrlListener aUrlListener,
00072                                    in nsIMsgFolder aInbox,
00073                     in nsIPop3IncomingServer popServer);
00074 
00075   nsIURI CheckForNewMail(in nsIMsgWindow aMsgWindow, in nsIUrlListener aUrlListener,
00076                                            in nsIMsgFolder inbox,
00077                          in nsIPop3IncomingServer popServer);
00078 };