Back to index

lightning-sunbird  0.9+nobinonly
mimehdrs.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 #ifndef _MIMEHDRS_H_
00039 #define _MIMEHDRS_H_
00040 
00041 #include "modlmime.h"
00042 
00043 /* This file defines the interface to message-header parsing and formatting
00044    code, including conversion to HTML. */
00045 
00046 /* Other structs defined later in this file.
00047  */
00048 
00049 /* Creation and destruction.
00050  */
00051 extern MimeHeaders *MimeHeaders_new (void);
00052 //extern void MimeHeaders_free (MimeHeaders *);
00053 //extern MimeHeaders *MimeHeaders_copy (MimeHeaders *);
00054 
00055 
00056 /* Feed this method the raw data from which you would like a header
00057    block to be parsed, one line at a time.  Feed it a blank line when
00058    you're done.  Returns negative on allocation-related failure.
00059  */
00060 extern int MimeHeaders_parse_line (const char *buffer, PRInt32 size,
00061                                                            MimeHeaders *hdrs);
00062 
00063 
00064 /* Converts a MimeHeaders object into HTML, by writing to the provided
00065    output function.
00066  */
00067 extern int MimeHeaders_write_headers_html (MimeHeaders *hdrs,
00068                                                                          MimeDisplayOptions *opt, 
00069                        PRBool             attachment);
00070 
00071 /*
00072  * Writes all headers to the mime emitter.
00073  */
00074 extern int 
00075 MimeHeaders_write_all_headers (MimeHeaders *, MimeDisplayOptions *, PRBool);
00076 
00077 /* Writes the headers as text/plain.
00078    This writes out a blank line after the headers, unless
00079    dont_write_content_type is true, in which case the header-block
00080    is not closed off, and none of the Content- headers are written.
00081  */
00082 extern int MimeHeaders_write_raw_headers (MimeHeaders *hdrs,
00083                                                                         MimeDisplayOptions *opt,
00084                                                                         PRBool dont_write_content_type);
00085 
00086 
00087 /* Some crypto-related HTML-generated utility routines.
00088  * XXX This may not be needed. XXX 
00089  */
00090 extern char *MimeHeaders_open_crypto_stamp(void);
00091 extern char *MimeHeaders_finish_open_crypto_stamp(void);
00092 extern char *MimeHeaders_close_crypto_stamp(void);
00093 extern char *MimeHeaders_make_crypto_stamp(PRBool encrypted_p,
00094 
00095    PRBool signed_p,
00096 
00097    PRBool good_p,
00098 
00099    PRBool unverified_p,
00100 
00101    PRBool close_parent_stamp_p,
00102 
00103    const char *stamp_url);
00104 
00105 /* Does all the heuristic silliness to find the filename in the given headers.
00106  */
00107 extern char *MimeHeaders_get_name(MimeHeaders *hdrs, MimeDisplayOptions *opt);
00108 
00109 extern char *mime_decode_filename(char *name, const char* charset,
00110                                   MimeDisplayOptions *opt);
00111 
00112 extern "C"  char * MIME_StripContinuations(char *original);
00113 
00114 #endif /* _MIMEHDRS_H_ */