mailnews/mime/public/nsIMimeEmitter.idl
author Jim Porter <squibblyflabbetydoo@gmail.com>
Wed, 18 Jan 2012 20:16:52 -0600
changeset 10454 4b50e227e649e5323341ac98822afc3217da62f3
parent 9057 b7e43ce5e3692590b5c528856b1331cbc8ef690b
child 12286 84ac3c71109811da751f0ef2d72108075938f094
permissions -rw-r--r--
Bug 718860 - Use the "dummy" smart reply button in the message header customization dialog; r=bwinton, ui-r=bwinton

/* -*- 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"
#include "nsrootidl.idl"

interface nsIOutputStream;
interface nsIInputStream;
interface nsIURI;
interface nsIStreamListener;
interface nsIChannel;

[scriptable, uuid(eb9beb09-44de-4ad2-a560-f572b1afd534)]
interface nsMimeHeaderDisplayTypes
{
    const long MicroHeaders = 0;
    const long NormalHeaders = 1;
    const long AllHeaders = 2;
};

%{C++
#define NS_IMIME_MISC_STATUS_KEY       "@mozilla.org/MimeMiscStatus;1?type="
%}

[scriptable, uuid(7a57166f-2891-4122-9a74-6c3fab0caac3)]
interface nsIMimeEmitter : nsISupports {

    // Output listener to allow access to it from mime.
    attribute nsIStreamListener outputListener;

    // These will be called to start and stop the total operation.
    void initialize(in nsIURI url, in nsIChannel aChannel, in long aFormat);
    void complete();

    // Set the output stream/listener for processed data.
    void setPipe(in nsIInputStream inputStream, in nsIOutputStream outStream);

    // Header handling routines.
    void startHeader(in boolean rootMailHeader, in boolean headerOnly,
                     [const] in string msgID, [const] in string outCharset);
    void addHeaderField([const] in string field, [const] in string value);
    void addAllHeaders(in ACString allheaders);

    /**
     * Write the HTML Headers for the current attachment.
     * Note: Book case this with an EndHeader call.
     *
     * @param name The name of this attachment.
     */
    void writeHTMLHeaders([const] in AUTF8String name);

    /**
     * Finish writing the headers for the current attachment.
     *
     * @param name The name of this attachment.
     */
    void endHeader([const] in AUTF8String name);

    void updateCharacterSet([const] in string aCharset);

    // Attachment handling routines.
    void startAttachment([const] in AUTF8String name,
                         [const] in string contentType,
                         [const] in string url, in boolean aNotDownloaded);
    void addAttachmentField([const] in string field, [const] in string value);
    void endAttachment();

    void endAllAttachments();

    // Body handling routines.
    void startBody(in boolean bodyOnly, [const] in string msgID, [const] in string outCharset);
    void writeBody([const] in AUTF8String buf, out PRUint32 amountWritten);
    void endBody();

    // Generic write routine. This is necessary for output that
    // libmime needs to pass through without any particular parsing
    // involved (i.e. decoded images, HTML Body Text, etc...
    void write([const] in ACString buf, out PRUint32 amountWritten);
    void utilityWrite([const] in string buf);
};