DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (379a2370cd89)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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):
 *   Jeff Tsai <jt95070@netscape.net>
 *
 * 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"
#include "MailNewsTypes2.idl"

interface nsIMsgWindow;
interface nsIMsgFolder;
interface nsIMimeHeaders;

typedef long EDisposeType;
typedef long ReceiptHdrType;
typedef long MDNIncorporateType;

%{C++
#define NS_MSGMDNGENERATOR_CONTRACTID \
  "@mozilla.org/messenger-mdn/generator;1"

#define NS_MSGMDNGENERATOR_CID                    \
{ /* ec917b13-8f73-4d4d-9146-d7f7aafe9076 */      \
 0xec917b13, 0x8f73, 0x4d4d,                      \
 { 0x91, 0x46, 0xd7, 0xf7, 0xaa, 0xfe, 0x90, 0x76 }}
%}

[scriptable, uuid(440EA3DE-DACA-4886-9875-84E6CD7D7927)]
interface nsIMsgMdnGenerator : nsISupports
{
    const EDisposeType eDisplayed = 0;
    const EDisposeType eDispatched = 1;
    const EDisposeType eProcessed = 2;
    const EDisposeType eDeleted = 3;
    const EDisposeType eDenied = 4;
    const EDisposeType eFailed = 5;
    
    const ReceiptHdrType eDntType = 0;
    const ReceiptHdrType eRrtType = 1;
    const ReceiptHdrType eDntRrtType = 2;
    
    const MDNIncorporateType eIncorporateInbox = 0;
    const MDNIncorporateType eIncorporateSent = 1;
    
    
    /**
     * Prepare the sending of a mdn reply, and checks the prefs whether a
     * reply should be send. Might send the message automatically if the
     * prefs say it should.
     * @param eType   One of EDisposeType above, indicating the action that led
     *                to sending the mdn reply
     * @param aWindow The window the message was displayed in, acting as parent
     *                for any (error) dialogs
     * @param folder  The folder the message is in
     * @param key     the message key
     * @param headers the message headers
     * @param autoAction  true if the request action led to sending the mdn
     *                reply was an automatic action, false if it was user initiated
     * @returns true if the user needs to be asked for permission
     *          false in other cases (whether the message was sent or denied)
     */
    boolean process(in EDisposeType eType, in nsIMsgWindow aWindow,
                    in nsIMsgFolder folder, in nsMsgKey key, 
                    in nsIMimeHeaders headers, in boolean autoAction);

    /**
     * Must be called when the user was asked for permission and agreed to
     * sending the mdn reply. 
     * May only be called when |process| returned |true|. Behaviour is
     * unspecified in other cases
     */
    void userAgreed();

    /**
     * Must be called when the user was asked for permission and declined to
     * send the mdn reply. 
     * Will mark the message so that the user won't be asked next time.
     * May only be called when |process| returned |true|. Behaviour is
     * unspecified in other cases.
     */
    void userDeclined();
};