Back to index

lightning-sunbird  0.9+nobinonly
nsIMimeEmitter.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 #include "nsISupports.idl"
00038 #include "nsrootidl.idl"
00039 
00040 interface nsIOutputStream;
00041 interface nsIInputStream;
00042 interface nsIURI;
00043 interface nsIStreamListener;
00044 interface nsIChannel;
00045 
00046 [scriptable, uuid(39E329E2-357F-11d3-8EFD-00A024A7D144)] 
00047 interface nsMimeHeaderDisplayTypes 
00048 { 
00049     const long MicroHeaders = 0; 
00050     const long NormalHeaders = 1; 
00051     const long AllHeaders = 2; 
00052 }; 
00053 
00054 %{C++
00055 //#define NS_IMIME_MISC_STATUS_KEY       "@mozilla.org/messenger/mimestatus;1?"
00056 #define NS_IMIME_MISC_STATUS_KEY       "@mozilla.org/MimeMiscStatus;1?type="
00057 %}
00058 
00059 [scriptable, uuid(D01D7B59-DCCD-11d2-A411-00805F613C79)]
00060 interface nsIMimeEmitter : nsISupports{
00061 
00062     // These will be called to start and stop the total operation
00063     void    Initialize(in nsIURI url, in nsIChannel aChannel, in long aFormat);
00064     void    Complete();
00065 
00066     // Set the output stream/listener for processed data.
00067     void    SetPipe(in nsIInputStream inputStream, in nsIOutputStream outStream);
00068     void    SetOutputListener(in nsIStreamListener listener);
00069     
00070     //Get the output listener to allow access to it from mime
00071     nsIStreamListener    GetOutputListener();
00072 
00073     // Header handling routines.
00074     void    StartHeader(in PRBool rootMailHeader, in PRBool headerOnly, 
00075                         [const] in string msgID, [const] in string outCharset);
00076     void    AddHeaderField([const] in string field, [const] in string value);
00077     void    addAllHeaders([const] in string allheaders, [const] in long allheadersize);
00078        void    WriteHTMLHeaders(); // book case this with a EndHeader call.
00079     void    EndHeader();
00080     void    UpdateCharacterSet([const] in string aCharset);
00081 
00082     // Attachment handling routines
00083     void    StartAttachment([const] in string name, [const] in string contentType, 
00084                             [const] in string url, in PRBool aNotDownloaded);
00085     void    AddAttachmentField([const] in string field, [const] in string value);
00086     void    EndAttachment();
00087 
00088     void    EndAllAttachments();
00089 
00090     // Body handling routines
00091     void    StartBody(in PRBool bodyOnly, [const] in string msgID, [const] in string outCharset);
00092     void    WriteBody([const] in string buf, in PRUint32 size, out PRUint32 amountWritten);
00093     void    EndBody();
00094 
00095     // Generic write routine. This is necessary for output that
00096     // libmime needs to pass through without any particular parsing
00097     // involved (i.e. decoded images, HTML Body Text, etc...
00098     void    Write([const] in string buf, in PRUint32 size, out PRUint32 amountWritten);
00099     void    UtilityWrite([const] in string buf);
00100 };
00101