RetroZilla/mailnews/compose/public/nsIMsgSendListener.idl
2015-10-20 23:03:22 -04:00

90 lines
3.5 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIFileSpec;
[scriptable, uuid(ED3D3227-2803-11D3-82B7-444553540002)]
interface nsIMsgSendListener : nsISupports {
/**
* Notify the observer that the message has started to be delivered. This method is
* called only once, at the beginning of a message send operation.
*
* @return The return value is currently ignored. In the future it may be
* used to cancel the URL load..
*/
void onStartSending(in string aMsgID, in PRUint32 aMsgSize);
/**
* Notify the observer that progress as occurred for the message send
*/
void onProgress(in string aMsgID, in PRUint32 aProgress, in PRUint32 aProgressMax);
/**
* Notify the observer with a status message for the message send
*/
void onStatus(in string aMsgID, in wstring aMsg);
/**
* Notify the observer that the message has been sent. This method is
* called once when the networking library has finished processing the
* message.
*
* This method is called regardless of whether the the operation was successful.
* aMsgID The message id for the mail message
* status Status code for the message send.
* msg A text string describing the error.
* returnFileSpec The returned file spec for save to file operations.
*/
void onStopSending(in string aMsgID, in nsresult aStatus, in wstring aMsg,
in nsIFileSpec returnFileSpec);
/**
* Notify the observer with the folder uri before the draft is copied.
*/
void onGetDraftFolderURI(in string aFolderURI);
/**
* Notify the observer when the user aborts the send without actually doing the send
* eg : by closing the compose window without Send.
*/
void onSendNotPerformed(in string aMsgID, in nsresult aStatus);
};