<refentry id="camel-CamelMimeFilterToHTML">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelMimeFilterToHTML.top_of_page">CamelMimeFilterToHTML</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CamelMimeFilterToHTML</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="camel-CamelMimeFilterToHTML.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="CamelMimeFilterToHTML">CamelMimeFilterToHTML</link>;
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-PRE:CAPS">CAMEL_MIME_FILTER_TOHTML_PRE</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-CONVERT-NL:CAPS">CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES:CAPS">CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS:CAPS">CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-MARK-CITATION:CAPS">CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES:CAPS">CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT:CAPS">CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-CITE:CAPS">CAMEL_MIME_FILTER_TOHTML_CITE</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT:CAPS">CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</link>
#define             <link linkend="CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED:CAPS">CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</link>
<link linkend="CamelMimeFilter">CamelMimeFilter</link>*    <link linkend="camel-mime-filter-tohtml-new">camel_mime_filter_tohtml_new</link>        (<link linkend="guint32">guint32</link> flags,
                                                         <link linkend="guint32">guint32</link> colour);
<link linkend="char">char</link>*               <link linkend="camel-text-to-html">camel_text_to_html</link>                  (const <link linkend="char">char</link> *in,
                                                         <link linkend="guint32">guint32</link> flags,
                                                         <link linkend="guint32">guint32</link> colour);
</synopsis>
</refsynopsisdiv>









<refsect1 id="camel-CamelMimeFilterToHTML.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="camel-CamelMimeFilterToHTML.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelMimeFilterToHTML" role="struct">
<title>CamelMimeFilterToHTML</title>
<indexterm zone="CamelMimeFilterToHTML"><primary>CamelMimeFilterToHTML</primary></indexterm><programlisting>typedef struct {
	CamelMimeFilter parent;
	
	struct _CamelUrlScanner *scanner;
	
	guint32 flags;
	guint32 colour;
	
	guint32 column   : 31;
	guint32 pre_open : 1;
} CamelMimeFilterToHTML;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-PRE:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_PRE</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-PRE:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_PRE</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_PRE               (1 &lt;&lt; 0)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-CONVERT-NL:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-CONVERT-NL:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_CONVERT_NL</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_CONVERT_NL        (1 &lt;&lt; 1)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-CONVERT-SPACES:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES    (1 &lt;&lt; 2)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-CONVERT-URLS:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS      (1 &lt;&lt; 3)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-MARK-CITATION:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-MARK-CITATION:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_MARK_CITATION</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_MARK_CITATION     (1 &lt;&lt; 4)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-CONVERT-ADDRESSES:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES (1 &lt;&lt; 5)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-ESCAPE-8BIT:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT       (1 &lt;&lt; 6)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-CITE:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_CITE</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-CITE:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_CITE</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_CITE              (1 &lt;&lt; 7)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-PRESERVE-8BIT:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT     (1 &lt;&lt; 8)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED:CAPS" role="macro">
<title>CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</title>
<indexterm zone="CAMEL-MIME-FILTER-TOHTML-FORMAT-FLOWED:CAPS"><primary>CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED</primary></indexterm><programlisting>#define CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED     (1 &lt;&lt; 9)
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-mime-filter-tohtml-new" role="function">
<title>camel_mime_filter_tohtml_new ()</title>
<indexterm zone="camel-mime-filter-tohtml-new"><primary>camel_mime_filter_tohtml_new</primary></indexterm><programlisting><link linkend="CamelMimeFilter">CamelMimeFilter</link>*    camel_mime_filter_tohtml_new        (<link linkend="guint32">guint32</link> flags,
                                                         <link linkend="guint32">guint32</link> colour);</programlisting>
<para>
Create a new <link linkend="CamelMimeFilterToHTML"><type>CamelMimeFilterToHTML</type></link> object to convert plain text
into HTML.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> bitwise flags defining the behaviour
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>colour</parameter>&nbsp;:</term>
<listitem><simpara> colour to use when highlighting quoted text
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a new <link linkend="CamelMimeFilterToHTML"><type>CamelMimeFilterToHTML</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-to-html" role="function">
<title>camel_text_to_html ()</title>
<indexterm zone="camel-text-to-html"><primary>camel_text_to_html</primary></indexterm><programlisting><link linkend="char">char</link>*               camel_text_to_html                  (const <link linkend="char">char</link> *in,
                                                         <link linkend="guint32">guint32</link> flags,
                                                         <link linkend="guint32">guint32</link> colour);</programlisting>
<para>
Convert <parameter>in</parameter> from plain text into HTML.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter>&nbsp;:</term>
<listitem><simpara> input text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> bitwise flags defining the html conversion behaviour
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>colour</parameter>&nbsp;:</term>
<listitem><simpara> colour to use when syntax highlighting
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a newly allocated string containing the HTMLified version
of <parameter>in</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
