Back to index

lightning-sunbird  0.9+nobinonly
nsIMimeStreamConverter.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 
00038 /*
00039        I've created this interface to contain mailnews mime specific information
00040        for stream converters. Most of this code is just stuff that has been moved out
00041        of nsIStreamConverter.idl to make it more generic.
00042 */
00043 
00044 #include "nsISupports.idl"
00045 #include "nsrootidl.idl"
00046 #include "nsIMimeHeaders.idl"
00047 #include "nsIMsgIdentity.idl"
00048 
00049 interface nsIURI;
00050 
00051 typedef long nsMimeOutputType;
00052 
00053 [scriptable, uuid(fdc2956e-d558-43fb-bfdd-fb9511229aa5)] 
00054 interface nsMimeOutput
00055 { 
00056   const long nsMimeMessageSplitDisplay = 0;
00057   const long nsMimeMessageHeaderDisplay = 1;
00058   const long nsMimeMessageBodyDisplay = 2;
00059        const long nsMimeMessageQuoting = 3;
00060        const long nsMimeMessageBodyQuoting = 4;
00061        const long nsMimeMessageRaw = 5;
00062        const long nsMimeMessageDraftOrTemplate = 6;
00063        const long nsMimeMessageEditorTemplate = 7;
00064        const long nsMimeMessagePrintOutput = 9;
00065   const long nsMimeMessageSaveAs = 10;
00066   const long nsMimeMessageSource = 11;
00067   const long nsMimeMessageFilterSniffer = 12;
00068   const long nsMimeMessageDecrypt = 13;
00069   const long nsMimeMessageAttach = 14;
00070   const long nsMimeUnknown = 15;
00071 }; 
00072 
00073 [scriptable, uuid(FA81CAA0-6261-11d3-8311-00805F2A0107)] 
00074 interface nsIMimeStreamConverterListener : nsISupports{
00075       void onHeadersReady(in nsIMimeHeaders headers);
00076 };
00077 
00078 [scriptable, uuid(E4ED8892-3F9E-11d3-9896-001083010E9B)]
00079 interface nsIMimeStreamConverter : nsISupports {
00080 
00081     /* 
00082         * This is used to set the desired mime output type on the converer. 
00083      */
00084 
00085        void SetMimeOutputType(in nsMimeOutputType aType);
00086 
00087        void GetMimeOutputType(out nsMimeOutputType aOutFormat);
00088     
00089   /* 
00090   * This is needed by libmime for MHTML link processing...the url is the URL string associated
00091   * with this input stream
00092   */ 
00093   void SetStreamURI(in nsIURI aURI); 
00094 
00095   /*
00096   * This is used to extract headers while parsing a message
00097   */
00098   void SetMimeHeadersListener(in nsIMimeStreamConverterListener listener, in nsMimeOutputType aType);
00099 
00100   /*
00101   * This is used for forward inline
00102   */
00103   attribute PRBool forwardInline;
00104 
00105   /*
00106   * This is used for OpenDraft, OpenEditorTemplate and Forward inline (which use OpenDraft)
00107   */
00108   attribute nsIMsgIdentity identity;
00109   attribute string originalMsgURI;
00110 };