Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgSendReport.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  *
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 "nsIPrompt.idl"
00040 
00041 
00042 [scriptable, uuid(2247c280-7f7f-11d5-9daa-994d49414e7c)]
00043 interface nsIMsgProcessReport : nsISupports {
00044 
00045   attribute boolean proceeded;
00046   attribute nsresult error;
00047   attribute wstring message;
00048   
00049   void reset();
00050 };
00051 
00052 [scriptable, uuid(2247c281-7f7f-11d5-9daa-994d49414e7c)]
00053 interface nsIMsgSendReport : nsISupports {
00054 
00055   const long process_Current = -1;
00056   const long process_BuildMessage = 0;
00057   const long process_NNTP = 1;
00058   const long process_SMTP = 2;
00059   const long process_Copy = 3;
00060   const long process_FCC = 4;
00061   
00062   attribute long deliveryMode;      /* see nsMsgDeliverMode in nsIMsgSend.idl for valid value */
00063   attribute long currentProcess;
00064 
00065   void reset();
00066   
00067   void setProceeded(in long process, in boolean proceeded);
00068   void setError(in long process, in nsresult error, in boolean overwriteError);
00069   void setMessage(in long process, in wstring message, in boolean overwriteMessage);
00070   
00071   nsIMsgProcessReport getProcessReport(in long process);
00072   
00073   /* Display Report will ananlyze data collected during the send and will show the most appropriate error.
00074      Also it will return the error code. In case of no error or if the error has been canceld, it will return
00075      NS_OK.
00076   */
00077   nsresult displayReport(in nsIPrompt prompt, in boolean showErrorOnly, in boolean dontShowReportTwice);
00078 };