Back to index

lightning-sunbird  0.9+nobinonly
nsISmtpService.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 
00040 interface nsISmtpServer;
00041 interface nsIURI;
00042 interface nsIUrlListener;
00043 interface nsISupportsArray;
00044 interface nsIMsgIdentity;
00045 interface nsIInterfaceRequestor;
00046 interface nsIFileSpec;
00047 interface nsIMsgStatusFeedback;
00048 interface nsIRequest;
00049 
00050 [scriptable, uuid(FBAF0F10-CA9B-11d2-8063-006008128C4E)]
00051 interface nsISmtpService : nsISupports {
00052   
00054   // SendMailMessage requires the file name of the message to send, the
00055   // sender, a comma delimited list of recipients.
00056   // It builds an Smtp url, makes an smtp connection and runs the url. If you
00057   // want a handle on the running task, pass in  a valid nsIURI ptr. You can
00058   // later interrupt this action by asking the netlib service manager to
00059   // interrupt the url you are given back. Remember to release aURL when you
00060   // are done with it. Pass nsnull in for aURL if you don't care about 
00061   // the returned URL.
00062   //
00063   // If you don't care about listening to the url, feel free to pass in
00064   // nsnull for that argument.
00065   //
00066   // You can also pass an password as an argument if you want to prevent
00067   // a dialog to popup if the password is needed for a secure transmission
00068   //
00069   // The server associate to the Sender Identity will be used or the default
00070   // server.
00072 
00073   void SendMailMessage(in nsIFileSpec aFilePath, in string aRecipients, 
00074                        in nsIMsgIdentity aSenderIdentity,
00075                        in string aPassword,
00076                        in nsIUrlListener aUrlListener, 
00077                                                 in nsIMsgStatusFeedback aStatusListener, 
00078                        in nsIInterfaceRequestor aNotificationCallbacks,
00079                        out nsIURI aURL,
00080                                                 out nsIRequest aRequest);
00081 
00085   void GetSmtpServerByIdentity(in nsIMsgIdentity aSenderIdentity,
00086                                out nsISmtpServer aServer);
00087 
00091   readonly attribute nsISupportsArray smtpServers;
00092 
00098   attribute nsISmtpServer defaultServer;
00099 
00105   attribute nsISmtpServer sessionDefaultServer;
00106 
00112   nsISmtpServer createSmtpServer();
00113 
00119   nsISmtpServer findServer(in string username, in string hostname);
00120 
00125   nsISmtpServer getServerByKey(in string key);
00126   
00133   void deleteSmtpServer(in nsISmtpServer server);
00134 
00135 };