~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-mime-filter-bestenc.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<refentry id="camel-CamelMimeFilterBestenc">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelMimeFilterBestenc.top_of_page">CamelMimeFilterBestenc</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelMimeFilterBestenc</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelMimeFilterBestenc.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
enum                <link linkend="CamelBestencRequired">CamelBestencRequired</link>;
18
 
enum                <link linkend="CamelBestencEncoding">CamelBestencEncoding</link>;
19
 
struct              <link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link>;
20
 
<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> * <link linkend="camel-mime-filter-bestenc-new">camel_mime_filter_bestenc_new</link>  (<link linkend="guint">guint</link> flags);
21
 
<link linkend="CamelTransferEncoding">CamelTransferEncoding</link>  <link linkend="camel-mime-filter-bestenc-get-best-encoding">camel_mime_filter_bestenc_get_best_encoding</link>
22
 
                                                        (<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> *filter,
23
 
                                                         <link linkend="CamelBestencEncoding">CamelBestencEncoding</link> required);
24
 
const <link linkend="gchar">gchar</link> *       <link linkend="camel-mime-filter-bestenc-get-best-charset">camel_mime_filter_bestenc_get_best_charset</link>
25
 
                                                        (<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> *filter);
26
 
<link linkend="void">void</link>                <link linkend="camel-mime-filter-bestenc-set-flags">camel_mime_filter_bestenc_set_flags</link> (<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> *filter,
27
 
                                                         <link linkend="guint">guint</link> flags);
28
 
</synopsis>
29
 
</refsynopsisdiv>
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
<refsect1 id="camel-CamelMimeFilterBestenc.description" role="desc">
40
 
<title role="desc.title">Description</title>
41
 
<para>
42
 
</para>
43
 
</refsect1>
44
 
 
45
 
<refsect1 id="camel-CamelMimeFilterBestenc.details" role="details">
46
 
<title role="details.title">Details</title>
47
 
<refsect2 id="CamelBestencRequired" role="enum">
48
 
<title>enum CamelBestencRequired</title>
49
 
<indexterm zone="CamelBestencRequired"><primary sortas="CamelBestencRequired">CamelBestencRequired</primary></indexterm><programlisting>typedef enum _CamelBestencRequired {
50
 
        CAMEL_BESTENC_GET_ENCODING = 1&lt;&lt;0,
51
 
        CAMEL_BESTENC_GET_CHARSET = 1&lt;&lt;1,
52
 
 
53
 
        /* do we treat 'lf' as if it were crlf? */
54
 
        CAMEL_BESTENC_LF_IS_CRLF = 1&lt;&lt;8,
55
 
        /* do we not allow "From " to appear at the start of a line in any part? */
56
 
        CAMEL_BESTENC_NO_FROM = 1&lt;&lt;9
57
 
} CamelBestencRequired;
58
 
</programlisting>
59
 
<para>
60
 
</para></refsect2>
61
 
<refsect2 id="CamelBestencEncoding" role="enum">
62
 
<title>enum CamelBestencEncoding</title>
63
 
<indexterm zone="CamelBestencEncoding"><primary sortas="CamelBestencEncoding">CamelBestencEncoding</primary></indexterm><programlisting>typedef enum _CamelBestencEncoding {
64
 
        CAMEL_BESTENC_7BIT,
65
 
        CAMEL_BESTENC_8BIT,
66
 
        CAMEL_BESTENC_BINARY,
67
 
 
68
 
        /* is the content stream to be treated as text? */
69
 
        CAMEL_BESTENC_TEXT = 1&lt;&lt;8
70
 
} CamelBestencEncoding;
71
 
</programlisting>
72
 
<para>
73
 
</para></refsect2>
74
 
<refsect2 id="CamelMimeFilterBestenc" role="struct">
75
 
<title>struct CamelMimeFilterBestenc</title>
76
 
<indexterm zone="CamelMimeFilterBestenc"><primary sortas="CamelMimeFilterBestenc">CamelMimeFilterBestenc</primary></indexterm><programlisting>struct CamelMimeFilterBestenc {
77
 
        CamelMimeFilter parent;
78
 
 
79
 
        guint flags;    /* our creation flags, see above */
80
 
 
81
 
        guint count0;   /* count of NUL characters */
82
 
        guint count8;   /* count of 8 bit characters */
83
 
        guint total;    /* total characters read */
84
 
 
85
 
        guint lastc;    /* the last character read */
86
 
        gint crlfnoorder;       /* if crlf's occured where they shouldn't have */
87
 
 
88
 
        gint startofline;       /* are we at the start of a new line? */
89
 
 
90
 
        gint fromcount;
91
 
        gchar fromsave[6];      /* save a few characters if we found an \n near the end of the buffer */
92
 
        gint hadfrom;           /* did we encounter a "\nFrom " in the data? */
93
 
 
94
 
        guint countline;        /* current count of characters on a given line */
95
 
        guint maxline;  /* max length of any line */
96
 
 
97
 
        CamelCharset charset;   /* used to determine the best charset to use */
98
 
};
99
 
</programlisting>
100
 
<para>
101
 
</para></refsect2>
102
 
<refsect2 id="camel-mime-filter-bestenc-new" role="function">
103
 
<title>camel_mime_filter_bestenc_new ()</title>
104
 
<indexterm zone="camel-mime-filter-bestenc-new"><primary sortas="camel_mime_filter_bestenc_new">camel_mime_filter_bestenc_new</primary></indexterm><programlisting><link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> * camel_mime_filter_bestenc_new  (<link linkend="guint">guint</link> flags);</programlisting>
105
 
<para>
106
 
Create a new <link linkend="CamelMimeFilterBestenc"><type>CamelMimeFilterBestenc</type></link> object.</para>
107
 
<para>
108
 
</para><variablelist role="params">
109
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
110
 
<listitem><simpara> a bitmask of data required.
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelMimeFilterBestenc"><type>CamelMimeFilterBestenc</type></link> object
113
 
</simpara></listitem></varlistentry>
114
 
</variablelist></refsect2>
115
 
<refsect2 id="camel-mime-filter-bestenc-get-best-encoding" role="function">
116
 
<title>camel_mime_filter_bestenc_get_best_encoding ()</title>
117
 
<indexterm zone="camel-mime-filter-bestenc-get-best-encoding"><primary sortas="camel_mime_filter_bestenc_get_best_encoding">camel_mime_filter_bestenc_get_best_encoding</primary></indexterm><programlisting><link linkend="CamelTransferEncoding">CamelTransferEncoding</link>  camel_mime_filter_bestenc_get_best_encoding
118
 
                                                        (<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> *filter,
119
 
                                                         <link linkend="CamelBestencEncoding">CamelBestencEncoding</link> required);</programlisting>
120
 
<para>
121
 
Get the best encoding, given specific constraints, that can be used to
122
 
encode a stream of bytes.</para>
123
 
<para>
124
 
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>filter</parameter>&#160;:</term>
126
 
<listitem><simpara> a <link linkend="CamelMimeFilterBestenc"><type>CamelMimeFilterBestenc</type></link> object
127
 
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><parameter>required</parameter>&#160;:</term>
129
 
<listitem><simpara> maximum level of output encoding allowed.
130
 
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the best encoding to use
132
 
</simpara></listitem></varlistentry>
133
 
</variablelist></refsect2>
134
 
<refsect2 id="camel-mime-filter-bestenc-get-best-charset" role="function">
135
 
<title>camel_mime_filter_bestenc_get_best_charset ()</title>
136
 
<indexterm zone="camel-mime-filter-bestenc-get-best-charset"><primary sortas="camel_mime_filter_bestenc_get_best_charset">camel_mime_filter_bestenc_get_best_charset</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       camel_mime_filter_bestenc_get_best_charset
137
 
                                                        (<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> *filter);</programlisting>
138
 
<para>
139
 
Gets the best charset that can be used to contain this content.</para>
140
 
<para>
141
 
</para><variablelist role="params">
142
 
<varlistentry><term><parameter>filter</parameter>&#160;:</term>
143
 
<listitem><simpara> a <link linkend="CamelMimeFilterBestenc"><type>CamelMimeFilterBestenc</type></link> object
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the name of the best charset to use to encode the input
146
 
text filtered by <parameter>filter</parameter>
147
 
</simpara></listitem></varlistentry>
148
 
</variablelist></refsect2>
149
 
<refsect2 id="camel-mime-filter-bestenc-set-flags" role="function">
150
 
<title>camel_mime_filter_bestenc_set_flags ()</title>
151
 
<indexterm zone="camel-mime-filter-bestenc-set-flags"><primary sortas="camel_mime_filter_bestenc_set_flags">camel_mime_filter_bestenc_set_flags</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_filter_bestenc_set_flags (<link linkend="CamelMimeFilterBestenc">CamelMimeFilterBestenc</link> *filter,
152
 
                                                         <link linkend="guint">guint</link> flags);</programlisting>
153
 
<para>
154
 
Set the flags for subsequent operations.</para>
155
 
<para>
156
 
</para><variablelist role="params">
157
 
<varlistentry><term><parameter>filter</parameter>&#160;:</term>
158
 
<listitem><simpara> a <link linkend="CamelMimeFilterBestenc"><type>CamelMimeFilterBestenc</type></link> object
159
 
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
161
 
<listitem><simpara> bestenc filter flags
162
 
</simpara></listitem></varlistentry>
163
 
</variablelist></refsect2>
164
 
 
165
 
</refsect1>
166
 
 
167
 
 
168
 
 
169
 
 
170
 
</refentry>