← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-mime-message.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
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* 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:
docs/reference/camel/xml/camel-mime-message.xml
1
 
<refentry id="camel-CamelMimeMessage">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelMimeMessage.top_of_page">CamelMimeMessage</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelMimeMessage</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelMimeMessage.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
struct              <link linkend="CamelMimeMessage">CamelMimeMessage</link>;
18
 
#define             <link linkend="CAMEL-RECIPIENT-TYPE-TO--CAPS">CAMEL_RECIPIENT_TYPE_TO</link>
19
 
#define             <link linkend="CAMEL-RECIPIENT-TYPE-CC--CAPS">CAMEL_RECIPIENT_TYPE_CC</link>
20
 
#define             <link linkend="CAMEL-RECIPIENT-TYPE-BCC--CAPS">CAMEL_RECIPIENT_TYPE_BCC</link>
21
 
#define             <link linkend="CAMEL-RECIPIENT-TYPE-RESENT-TO--CAPS">CAMEL_RECIPIENT_TYPE_RESENT_TO</link>
22
 
#define             <link linkend="CAMEL-RECIPIENT-TYPE-RESENT-CC--CAPS">CAMEL_RECIPIENT_TYPE_RESENT_CC</link>
23
 
#define             <link linkend="CAMEL-RECIPIENT-TYPE-RESENT-BCC--CAPS">CAMEL_RECIPIENT_TYPE_RESENT_BCC</link>
24
 
#define             <link linkend="CAMEL-MESSAGE-DATE-CURRENT--CAPS">CAMEL_MESSAGE_DATE_CURRENT</link>
25
 
<link linkend="CamelMimeMessage">CamelMimeMessage</link> *  <link linkend="camel-mime-message-new">camel_mime_message_new</link>              (void);
26
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-date">camel_mime_message_set_date</link>         (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
27
 
                                                         <link linkend="time-t">time_t</link> date,
28
 
                                                         <link linkend="gint">gint</link> offset);
29
 
<link linkend="time-t">time_t</link>              <link linkend="camel-mime-message-get-date">camel_mime_message_get_date</link>         (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
30
 
                                                         <link linkend="gint">gint</link> *offset);
31
 
<link linkend="time-t">time_t</link>              <link linkend="camel-mime-message-get-date-received">camel_mime_message_get_date_received</link>
32
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
33
 
                                                         <link linkend="gint">gint</link> *offset);
34
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-message-id">camel_mime_message_set_message_id</link>   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
35
 
                                                         const <link linkend="gchar">gchar</link> *message_id);
36
 
const <link linkend="gchar">gchar</link> *       <link linkend="camel-mime-message-get-message-id">camel_mime_message_get_message_id</link>   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
37
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-reply-to">camel_mime_message_set_reply_to</link>     (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
38
 
                                                         const <link linkend="CamelInternetAddress">CamelInternetAddress</link> *reply_to);
39
 
const <link linkend="CamelInternetAddress">CamelInternetAddress</link> * <link linkend="camel-mime-message-get-reply-to">camel_mime_message_get_reply_to</link>
40
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
41
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-subject">camel_mime_message_set_subject</link>      (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
42
 
                                                         const <link linkend="gchar">gchar</link> *subject);
43
 
const <link linkend="gchar">gchar</link> *       <link linkend="camel-mime-message-get-subject">camel_mime_message_get_subject</link>      (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
44
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-from">camel_mime_message_set_from</link>         (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
45
 
                                                         const <link linkend="CamelInternetAddress">CamelInternetAddress</link> *from);
46
 
const <link linkend="CamelInternetAddress">CamelInternetAddress</link> * <link linkend="camel-mime-message-get-from">camel_mime_message_get_from</link>
47
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
48
 
const <link linkend="CamelInternetAddress">CamelInternetAddress</link> * <link linkend="camel-mime-message-get-recipients">camel_mime_message_get_recipients</link>
49
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
50
 
                                                         const <link linkend="gchar">gchar</link> *type);
51
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-recipients">camel_mime_message_set_recipients</link>   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
52
 
                                                         const <link linkend="gchar">gchar</link> *type,
53
 
                                                         const <link linkend="CamelInternetAddress">CamelInternetAddress</link> *recipients);
54
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-source">camel_mime_message_set_source</link>       (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
55
 
                                                         const <link linkend="gchar">gchar</link> *identity);
56
 
const <link linkend="gchar">gchar</link> *       <link linkend="camel-mime-message-get-source">camel_mime_message_get_source</link>       (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
57
 
<link linkend="gboolean">gboolean</link>            <link linkend="camel-mime-message-has-8bit-parts">camel_mime_message_has_8bit_parts</link>   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
58
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-set-best-encoding">camel_mime_message_set_best_encoding</link>
59
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
60
 
                                                         <link linkend="CamelBestencRequired">CamelBestencRequired</link> required,
61
 
                                                         <link linkend="CamelBestencEncoding">CamelBestencEncoding</link> enctype);
62
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-encode-8bit-parts">camel_mime_message_encode_8bit_parts</link>
63
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
64
 
<link linkend="CamelMimePart">CamelMimePart</link> *     <link linkend="camel-mime-message-get-part-by-content-id">camel_mime_message_get_part_by_content_id</link>
65
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
66
 
                                                         const <link linkend="gchar">gchar</link> *content_id);
67
 
<link linkend="gchar">gchar</link> *             <link linkend="camel-mime-message-build-mbox-from">camel_mime_message_build_mbox_from</link>  (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
68
 
<link linkend="gboolean">gboolean</link>            <link linkend="camel-mime-message-has-attachment">camel_mime_message_has_attachment</link>   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
69
 
<link linkend="void">void</link>                <link linkend="camel-mime-message-dump">camel_mime_message_dump</link>             (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *msg,
70
 
                                                         <link linkend="gint">gint</link> body);
71
 
</synopsis>
72
 
</refsynopsisdiv>
73
 
 
74
 
 
75
 
 
76
 
 
77
 
 
78
 
 
79
 
 
80
 
 
81
 
 
82
 
<refsect1 id="camel-CamelMimeMessage.description" role="desc">
83
 
<title role="desc.title">Description</title>
84
 
<para>
85
 
</para>
86
 
</refsect1>
87
 
 
88
 
<refsect1 id="camel-CamelMimeMessage.details" role="details">
89
 
<title role="details.title">Details</title>
90
 
<refsect2 id="CamelMimeMessage" role="struct">
91
 
<title>struct CamelMimeMessage</title>
92
 
<indexterm zone="CamelMimeMessage"><primary sortas="CamelMimeMessage">CamelMimeMessage</primary></indexterm><programlisting>struct CamelMimeMessage {
93
 
        CamelMimePart parent_object;
94
 
 
95
 
        /* header fields */
96
 
        time_t date;
97
 
        gint date_offset;       /* GMT offset */
98
 
 
99
 
        /* cached internal copy */
100
 
        time_t date_received;
101
 
        gint date_received_offset;      /* GMT offset */
102
 
 
103
 
        gchar *subject;
104
 
 
105
 
        gchar *message_id;
106
 
 
107
 
        CamelInternetAddress *reply_to;
108
 
        CamelInternetAddress *from;
109
 
 
110
 
        GHashTable *recipients; /* hash table of CamelInternetAddress's */
111
 
};
112
 
</programlisting>
113
 
<para>
114
 
</para></refsect2>
115
 
<refsect2 id="CAMEL-RECIPIENT-TYPE-TO--CAPS" role="macro">
116
 
<title>CAMEL_RECIPIENT_TYPE_TO</title>
117
 
<indexterm zone="CAMEL-RECIPIENT-TYPE-TO--CAPS"><primary sortas="CAMEL_RECIPIENT_TYPE_TO">CAMEL_RECIPIENT_TYPE_TO</primary></indexterm><programlisting>#define CAMEL_RECIPIENT_TYPE_TO "To"
118
 
</programlisting>
119
 
<para>
120
 
</para></refsect2>
121
 
<refsect2 id="CAMEL-RECIPIENT-TYPE-CC--CAPS" role="macro">
122
 
<title>CAMEL_RECIPIENT_TYPE_CC</title>
123
 
<indexterm zone="CAMEL-RECIPIENT-TYPE-CC--CAPS"><primary sortas="CAMEL_RECIPIENT_TYPE_CC">CAMEL_RECIPIENT_TYPE_CC</primary></indexterm><programlisting>#define CAMEL_RECIPIENT_TYPE_CC "Cc"
124
 
</programlisting>
125
 
<para>
126
 
</para></refsect2>
127
 
<refsect2 id="CAMEL-RECIPIENT-TYPE-BCC--CAPS" role="macro">
128
 
<title>CAMEL_RECIPIENT_TYPE_BCC</title>
129
 
<indexterm zone="CAMEL-RECIPIENT-TYPE-BCC--CAPS"><primary sortas="CAMEL_RECIPIENT_TYPE_BCC">CAMEL_RECIPIENT_TYPE_BCC</primary></indexterm><programlisting>#define CAMEL_RECIPIENT_TYPE_BCC "Bcc"
130
 
</programlisting>
131
 
<para>
132
 
</para></refsect2>
133
 
<refsect2 id="CAMEL-RECIPIENT-TYPE-RESENT-TO--CAPS" role="macro">
134
 
<title>CAMEL_RECIPIENT_TYPE_RESENT_TO</title>
135
 
<indexterm zone="CAMEL-RECIPIENT-TYPE-RESENT-TO--CAPS"><primary sortas="CAMEL_RECIPIENT_TYPE_RESENT_TO">CAMEL_RECIPIENT_TYPE_RESENT_TO</primary></indexterm><programlisting>#define CAMEL_RECIPIENT_TYPE_RESENT_TO "Resent-To"
136
 
</programlisting>
137
 
<para>
138
 
</para></refsect2>
139
 
<refsect2 id="CAMEL-RECIPIENT-TYPE-RESENT-CC--CAPS" role="macro">
140
 
<title>CAMEL_RECIPIENT_TYPE_RESENT_CC</title>
141
 
<indexterm zone="CAMEL-RECIPIENT-TYPE-RESENT-CC--CAPS"><primary sortas="CAMEL_RECIPIENT_TYPE_RESENT_CC">CAMEL_RECIPIENT_TYPE_RESENT_CC</primary></indexterm><programlisting>#define CAMEL_RECIPIENT_TYPE_RESENT_CC "Resent-Cc"
142
 
</programlisting>
143
 
<para>
144
 
</para></refsect2>
145
 
<refsect2 id="CAMEL-RECIPIENT-TYPE-RESENT-BCC--CAPS" role="macro">
146
 
<title>CAMEL_RECIPIENT_TYPE_RESENT_BCC</title>
147
 
<indexterm zone="CAMEL-RECIPIENT-TYPE-RESENT-BCC--CAPS"><primary sortas="CAMEL_RECIPIENT_TYPE_RESENT_BCC">CAMEL_RECIPIENT_TYPE_RESENT_BCC</primary></indexterm><programlisting>#define CAMEL_RECIPIENT_TYPE_RESENT_BCC "Resent-Bcc"
148
 
</programlisting>
149
 
<para>
150
 
</para></refsect2>
151
 
<refsect2 id="CAMEL-MESSAGE-DATE-CURRENT--CAPS" role="macro">
152
 
<title>CAMEL_MESSAGE_DATE_CURRENT</title>
153
 
<indexterm zone="CAMEL-MESSAGE-DATE-CURRENT--CAPS"><primary sortas="CAMEL_MESSAGE_DATE_CURRENT">CAMEL_MESSAGE_DATE_CURRENT</primary></indexterm><programlisting>#define CAMEL_MESSAGE_DATE_CURRENT (~0)
154
 
</programlisting>
155
 
<para>
156
 
</para></refsect2>
157
 
<refsect2 id="camel-mime-message-new" role="function">
158
 
<title>camel_mime_message_new ()</title>
159
 
<indexterm zone="camel-mime-message-new"><primary sortas="camel_mime_message_new">camel_mime_message_new</primary></indexterm><programlisting><link linkend="CamelMimeMessage">CamelMimeMessage</link> *  camel_mime_message_new              (void);</programlisting>
160
 
<para>
161
 
Create a new <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object.</para>
162
 
<para>
163
 
</para><variablelist role="params">
164
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
165
 
</simpara></listitem></varlistentry>
166
 
</variablelist></refsect2>
167
 
<refsect2 id="camel-mime-message-set-date" role="function">
168
 
<title>camel_mime_message_set_date ()</title>
169
 
<indexterm zone="camel-mime-message-set-date"><primary sortas="camel_mime_message_set_date">camel_mime_message_set_date</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_date         (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
170
 
                                                         <link linkend="time-t">time_t</link> date,
171
 
                                                         <link linkend="gint">gint</link> offset);</programlisting>
172
 
<para>
173
 
Set the date on a message.</para>
174
 
<para>
175
 
</para><variablelist role="params">
176
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
177
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
178
 
</simpara></listitem></varlistentry>
179
 
<varlistentry><term><parameter>date</parameter>&#160;:</term>
180
 
<listitem><simpara> a time_t date
181
 
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>offset</parameter>&#160;:</term>
183
 
<listitem><simpara> an offset from GMT
184
 
</simpara></listitem></varlistentry>
185
 
</variablelist></refsect2>
186
 
<refsect2 id="camel-mime-message-get-date" role="function">
187
 
<title>camel_mime_message_get_date ()</title>
188
 
<indexterm zone="camel-mime-message-get-date"><primary sortas="camel_mime_message_get_date">camel_mime_message_get_date</primary></indexterm><programlisting><link linkend="time-t">time_t</link>              camel_mime_message_get_date         (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
189
 
                                                         <link linkend="gint">gint</link> *offset);</programlisting>
190
 
<para>
191
 
Get the date and GMT offset of a message.</para>
192
 
<para>
193
 
</para><variablelist role="params">
194
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
195
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
196
 
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><parameter>offset</parameter>&#160;:</term>
198
 
<listitem><simpara> output for the GMT offset
199
 
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the date of the message
201
 
</simpara></listitem></varlistentry>
202
 
</variablelist></refsect2>
203
 
<refsect2 id="camel-mime-message-get-date-received" role="function">
204
 
<title>camel_mime_message_get_date_received ()</title>
205
 
<indexterm zone="camel-mime-message-get-date-received"><primary sortas="camel_mime_message_get_date_received">camel_mime_message_get_date_received</primary></indexterm><programlisting><link linkend="time-t">time_t</link>              camel_mime_message_get_date_received
206
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
207
 
                                                         <link linkend="gint">gint</link> *offset);</programlisting>
208
 
<para>
209
 
Get the received date and GMT offset of a message.</para>
210
 
<para>
211
 
</para><variablelist role="params">
212
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
213
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>offset</parameter>&#160;:</term>
216
 
<listitem><simpara> output for the GMT offset
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the received date of the message
219
 
</simpara></listitem></varlistentry>
220
 
</variablelist></refsect2>
221
 
<refsect2 id="camel-mime-message-set-message-id" role="function">
222
 
<title>camel_mime_message_set_message_id ()</title>
223
 
<indexterm zone="camel-mime-message-set-message-id"><primary sortas="camel_mime_message_set_message_id">camel_mime_message_set_message_id</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_message_id   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
224
 
                                                         const <link linkend="gchar">gchar</link> *message_id);</programlisting>
225
 
<para>
226
 
Set the message-id on a message.</para>
227
 
<para>
228
 
</para><variablelist role="params">
229
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
230
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
231
 
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>message_id</parameter>&#160;:</term>
233
 
<listitem><simpara> id of the message
234
 
</simpara></listitem></varlistentry>
235
 
</variablelist></refsect2>
236
 
<refsect2 id="camel-mime-message-get-message-id" role="function">
237
 
<title>camel_mime_message_get_message_id ()</title>
238
 
<indexterm zone="camel-mime-message-get-message-id"><primary sortas="camel_mime_message_get_message_id">camel_mime_message_get_message_id</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       camel_mime_message_get_message_id   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
239
 
<para>
240
 
Get the message-id of a message.</para>
241
 
<para>
242
 
</para><variablelist role="params">
243
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
244
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
245
 
</simpara></listitem></varlistentry>
246
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message-id of a message
247
 
</simpara></listitem></varlistentry>
248
 
</variablelist></refsect2>
249
 
<refsect2 id="camel-mime-message-set-reply-to" role="function">
250
 
<title>camel_mime_message_set_reply_to ()</title>
251
 
<indexterm zone="camel-mime-message-set-reply-to"><primary sortas="camel_mime_message_set_reply_to">camel_mime_message_set_reply_to</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_reply_to     (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
252
 
                                                         const <link linkend="CamelInternetAddress">CamelInternetAddress</link> *reply_to);</programlisting>
253
 
<para>
254
 
Set the Reply-To of a message.</para>
255
 
<para>
256
 
</para><variablelist role="params">
257
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
258
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
259
 
</simpara></listitem></varlistentry>
260
 
<varlistentry><term><parameter>reply_to</parameter>&#160;:</term>
261
 
<listitem><simpara> a <link linkend="CamelInternetAddress"><type>CamelInternetAddress</type></link> object
262
 
</simpara></listitem></varlistentry>
263
 
</variablelist></refsect2>
264
 
<refsect2 id="camel-mime-message-get-reply-to" role="function">
265
 
<title>camel_mime_message_get_reply_to ()</title>
266
 
<indexterm zone="camel-mime-message-get-reply-to"><primary sortas="camel_mime_message_get_reply_to">camel_mime_message_get_reply_to</primary></indexterm><programlisting>const <link linkend="CamelInternetAddress">CamelInternetAddress</link> * camel_mime_message_get_reply_to
267
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
268
 
<para>
269
 
Get the Reply-To of a message.</para>
270
 
<para>
271
 
</para><variablelist role="params">
272
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
273
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
274
 
</simpara></listitem></varlistentry>
275
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the Reply-Toa ddress of the message
276
 
</simpara></listitem></varlistentry>
277
 
</variablelist></refsect2>
278
 
<refsect2 id="camel-mime-message-set-subject" role="function">
279
 
<title>camel_mime_message_set_subject ()</title>
280
 
<indexterm zone="camel-mime-message-set-subject"><primary sortas="camel_mime_message_set_subject">camel_mime_message_set_subject</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_subject      (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
281
 
                                                         const <link linkend="gchar">gchar</link> *subject);</programlisting>
282
 
<para>
283
 
Set the subject text of a message.</para>
284
 
<para>
285
 
</para><variablelist role="params">
286
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
287
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
288
 
</simpara></listitem></varlistentry>
289
 
<varlistentry><term><parameter>subject</parameter>&#160;:</term>
290
 
<listitem><simpara> UTF-8 message subject
291
 
</simpara></listitem></varlistentry>
292
 
</variablelist></refsect2>
293
 
<refsect2 id="camel-mime-message-get-subject" role="function">
294
 
<title>camel_mime_message_get_subject ()</title>
295
 
<indexterm zone="camel-mime-message-get-subject"><primary sortas="camel_mime_message_get_subject">camel_mime_message_get_subject</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       camel_mime_message_get_subject      (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
296
 
<para>
297
 
Get the UTF-8 subject text of a message.</para>
298
 
<para>
299
 
</para><variablelist role="params">
300
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
301
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
302
 
</simpara></listitem></varlistentry>
303
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message subject
304
 
</simpara></listitem></varlistentry>
305
 
</variablelist></refsect2>
306
 
<refsect2 id="camel-mime-message-set-from" role="function">
307
 
<title>camel_mime_message_set_from ()</title>
308
 
<indexterm zone="camel-mime-message-set-from"><primary sortas="camel_mime_message_set_from">camel_mime_message_set_from</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_from         (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
309
 
                                                         const <link linkend="CamelInternetAddress">CamelInternetAddress</link> *from);</programlisting>
310
 
<para>
311
 
Set the from address of a message.</para>
312
 
<para>
313
 
</para><variablelist role="params">
314
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
315
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
316
 
</simpara></listitem></varlistentry>
317
 
<varlistentry><term><parameter>from</parameter>&#160;:</term>
318
 
<listitem><simpara> a <link linkend="CamelInternetAddress"><type>CamelInternetAddress</type></link> object
319
 
</simpara></listitem></varlistentry>
320
 
</variablelist></refsect2>
321
 
<refsect2 id="camel-mime-message-get-from" role="function">
322
 
<title>camel_mime_message_get_from ()</title>
323
 
<indexterm zone="camel-mime-message-get-from"><primary sortas="camel_mime_message_get_from">camel_mime_message_get_from</primary></indexterm><programlisting>const <link linkend="CamelInternetAddress">CamelInternetAddress</link> * camel_mime_message_get_from
324
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
325
 
<para>
326
 
Get the from address of a message.</para>
327
 
<para>
328
 
</para><variablelist role="params">
329
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
330
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
331
 
</simpara></listitem></varlistentry>
332
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the from address of the message
333
 
</simpara></listitem></varlistentry>
334
 
</variablelist></refsect2>
335
 
<refsect2 id="camel-mime-message-get-recipients" role="function">
336
 
<title>camel_mime_message_get_recipients ()</title>
337
 
<indexterm zone="camel-mime-message-get-recipients"><primary sortas="camel_mime_message_get_recipients">camel_mime_message_get_recipients</primary></indexterm><programlisting>const <link linkend="CamelInternetAddress">CamelInternetAddress</link> * camel_mime_message_get_recipients
338
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
339
 
                                                         const <link linkend="gchar">gchar</link> *type);</programlisting>
340
 
<para>
341
 
Get the message recipients of a specified type.</para>
342
 
<para>
343
 
</para><variablelist role="params">
344
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
345
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
346
 
</simpara></listitem></varlistentry>
347
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
348
 
<listitem><simpara> recipient type
349
 
</simpara></listitem></varlistentry>
350
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the requested recipients
351
 
</simpara></listitem></varlistentry>
352
 
</variablelist></refsect2>
353
 
<refsect2 id="camel-mime-message-set-recipients" role="function">
354
 
<title>camel_mime_message_set_recipients ()</title>
355
 
<indexterm zone="camel-mime-message-set-recipients"><primary sortas="camel_mime_message_set_recipients">camel_mime_message_set_recipients</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_recipients   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
356
 
                                                         const <link linkend="gchar">gchar</link> *type,
357
 
                                                         const <link linkend="CamelInternetAddress">CamelInternetAddress</link> *recipients);</programlisting>
358
 
<para>
359
 
Set the recipients of a message.</para>
360
 
<para>
361
 
</para><variablelist role="params">
362
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
363
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
364
 
</simpara></listitem></varlistentry>
365
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
366
 
<listitem><simpara> recipient type (one of <link linkend="CAMEL-RECIPIENT-TYPE-TO--CAPS"><type>CAMEL_RECIPIENT_TYPE_TO</type></link>, <link linkend="CAMEL-RECIPIENT-TYPE-CC--CAPS"><type>CAMEL_RECIPIENT_TYPE_CC</type></link>, or <link linkend="CAMEL-RECIPIENT-TYPE-BCC--CAPS"><type>CAMEL_RECIPIENT_TYPE_BCC</type></link>)
367
 
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><parameter>recipients</parameter>&#160;:</term>
369
 
<listitem><simpara> a <link linkend="CamelInternetAddress"><type>CamelInternetAddress</type></link> with the recipient addresses set
370
 
</simpara></listitem></varlistentry>
371
 
</variablelist></refsect2>
372
 
<refsect2 id="camel-mime-message-set-source" role="function">
373
 
<title>camel_mime_message_set_source ()</title>
374
 
<indexterm zone="camel-mime-message-set-source"><primary sortas="camel_mime_message_set_source">camel_mime_message_set_source</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_source       (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
375
 
                                                         const <link linkend="gchar">gchar</link> *identity);</programlisting>
376
 
<para>
377
 
</para><variablelist role="params">
378
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
379
 
<listitem><simpara>
380
 
</simpara></listitem></varlistentry>
381
 
<varlistentry><term><parameter>identity</parameter>&#160;:</term>
382
 
<listitem><simpara>
383
 
</simpara></listitem></varlistentry>
384
 
</variablelist></refsect2>
385
 
<refsect2 id="camel-mime-message-get-source" role="function">
386
 
<title>camel_mime_message_get_source ()</title>
387
 
<indexterm zone="camel-mime-message-get-source"><primary sortas="camel_mime_message_get_source">camel_mime_message_get_source</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       camel_mime_message_get_source       (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
388
 
<para>
389
 
</para><variablelist role="params">
390
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
391
 
<listitem><simpara>
392
 
</simpara></listitem></varlistentry>
393
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
394
 
</simpara></listitem></varlistentry>
395
 
</variablelist></refsect2>
396
 
<refsect2 id="camel-mime-message-has-8bit-parts" role="function">
397
 
<title>camel_mime_message_has_8bit_parts ()</title>
398
 
<indexterm zone="camel-mime-message-has-8bit-parts"><primary sortas="camel_mime_message_has_8bit_parts">camel_mime_message_has_8bit_parts</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_mime_message_has_8bit_parts   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
399
 
<para>
400
 
Find out if a message contains 8bit or binary encoded parts.</para>
401
 
<para>
402
 
</para><variablelist role="params">
403
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
404
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
405
 
</simpara></listitem></varlistentry>
406
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the message contains 8bit parts or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
407
 
</simpara></listitem></varlistentry>
408
 
</variablelist></refsect2>
409
 
<refsect2 id="camel-mime-message-set-best-encoding" role="function">
410
 
<title>camel_mime_message_set_best_encoding ()</title>
411
 
<indexterm zone="camel-mime-message-set-best-encoding"><primary sortas="camel_mime_message_set_best_encoding">camel_mime_message_set_best_encoding</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_set_best_encoding
412
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
413
 
                                                         <link linkend="CamelBestencRequired">CamelBestencRequired</link> required,
414
 
                                                         <link linkend="CamelBestencEncoding">CamelBestencEncoding</link> enctype);</programlisting>
415
 
<para>
416
 
Re-encode all message parts to conform with the required encoding rules.
417
 
</para>
418
 
<para>
419
 
If <parameter>enctype</parameter> is <link linkend="CAMEL-BESTENC-7BIT--CAPS"><type>CAMEL_BESTENC_7BIT</type></link>, then all parts will be re-encoded into
420
 
one of the 7bit transfer encodings. If <parameter>enctype</parameter> is <link linkend="CAMEL-BESTENC-8bit"><type>CAMEL_BESTENC_8bit</type></link>, all
421
 
parts will be re-encoded to either a 7bit encoding or, if the part is 8bit
422
 
text, allowed to stay 8bit. If <parameter>enctype</parameter> is <link linkend="CAMEL-BESTENC-BINARY--CAPS"><type>CAMEL_BESTENC_BINARY</type></link>, then binary
423
 
parts will be encoded as binary and 8bit textual parts will be encoded as 8bit.</para>
424
 
<para>
425
 
</para><variablelist role="params">
426
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
427
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
428
 
</simpara></listitem></varlistentry>
429
 
<varlistentry><term><parameter>required</parameter>&#160;:</term>
430
 
<listitem><simpara> a bitwise ORing of <link linkend="CAMEL-BESTENC-GET-ENCODING--CAPS"><type>CAMEL_BESTENC_GET_ENCODING</type></link> and <link linkend="CAMEL-BESTENC-GET-CHARSET--CAPS"><type>CAMEL_BESTENC_GET_CHARSET</type></link>
431
 
</simpara></listitem></varlistentry>
432
 
<varlistentry><term><parameter>enctype</parameter>&#160;:</term>
433
 
<listitem><simpara> an encoding to enforce
434
 
</simpara></listitem></varlistentry>
435
 
</variablelist></refsect2>
436
 
<refsect2 id="camel-mime-message-encode-8bit-parts" role="function">
437
 
<title>camel_mime_message_encode_8bit_parts ()</title>
438
 
<indexterm zone="camel-mime-message-encode-8bit-parts"><primary sortas="camel_mime_message_encode_8bit_parts">camel_mime_message_encode_8bit_parts</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_encode_8bit_parts
439
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
440
 
<para>
441
 
Encode all message parts to a suitable transfer encoding for transport (7bit clean).</para>
442
 
<para>
443
 
</para><variablelist role="params">
444
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
445
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
446
 
</simpara></listitem></varlistentry>
447
 
</variablelist></refsect2>
448
 
<refsect2 id="camel-mime-message-get-part-by-content-id" role="function">
449
 
<title>camel_mime_message_get_part_by_content_id ()</title>
450
 
<indexterm zone="camel-mime-message-get-part-by-content-id"><primary sortas="camel_mime_message_get_part_by_content_id">camel_mime_message_get_part_by_content_id</primary></indexterm><programlisting><link linkend="CamelMimePart">CamelMimePart</link> *     camel_mime_message_get_part_by_content_id
451
 
                                                        (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
452
 
                                                         const <link linkend="gchar">gchar</link> *content_id);</programlisting>
453
 
<para>
454
 
Get a MIME part by id from a message.</para>
455
 
<para>
456
 
</para><variablelist role="params">
457
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
458
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
459
 
</simpara></listitem></varlistentry>
460
 
<varlistentry><term><parameter>content_id</parameter>&#160;:</term>
461
 
<listitem><simpara> content-id to search for
462
 
</simpara></listitem></varlistentry>
463
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the MIME part with the requested id or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if not found
464
 
</simpara></listitem></varlistentry>
465
 
</variablelist></refsect2>
466
 
<refsect2 id="camel-mime-message-build-mbox-from" role="function">
467
 
<title>camel_mime_message_build_mbox_from ()</title>
468
 
<indexterm zone="camel-mime-message-build-mbox-from"><primary sortas="camel_mime_message_build_mbox_from">camel_mime_message_build_mbox_from</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             camel_mime_message_build_mbox_from  (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
469
 
<para>
470
 
Build an MBox from-line from <parameter>message</parameter>.</para>
471
 
<para>
472
 
</para><variablelist role="params">
473
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
474
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
475
 
</simpara></listitem></varlistentry>
476
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an MBox from-line suitable for use in an mbox file
477
 
</simpara></listitem></varlistentry>
478
 
</variablelist></refsect2>
479
 
<refsect2 id="camel-mime-message-has-attachment" role="function">
480
 
<title>camel_mime_message_has_attachment ()</title>
481
 
<indexterm zone="camel-mime-message-has-attachment"><primary sortas="camel_mime_message_has_attachment">camel_mime_message_has_attachment</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_mime_message_has_attachment   (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
482
 
<para>
483
 
</para>
484
 
<para>
485
 
</para><variablelist role="params">
486
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
487
 
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
488
 
</simpara></listitem></varlistentry>
489
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>whether message contains at least one attachment part.
490
 
</simpara></listitem></varlistentry>
491
 
</variablelist></refsect2>
492
 
<refsect2 id="camel-mime-message-dump" role="function">
493
 
<title>camel_mime_message_dump ()</title>
494
 
<indexterm zone="camel-mime-message-dump"><primary sortas="camel_mime_message_dump">camel_mime_message_dump</primary></indexterm><programlisting><link linkend="void">void</link>                camel_mime_message_dump             (<link linkend="CamelMimeMessage">CamelMimeMessage</link> *msg,
495
 
                                                         <link linkend="gint">gint</link> body);</programlisting>
496
 
<para>
497
 
Dump information about the mime message to stdout.
498
 
</para>
499
 
<para>
500
 
If body is TRUE, then dump body content of the message as well (currently unimplemented).</para>
501
 
<para>
502
 
</para><variablelist role="params">
503
 
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
504
 
<listitem><simpara>
505
 
</simpara></listitem></varlistentry>
506
 
<varlistentry><term><parameter>body</parameter>&#160;:</term>
507
 
<listitem><simpara>
508
 
</simpara></listitem></varlistentry>
509
 
</variablelist></refsect2>
510
 
 
511
 
</refsect1>
512
 
 
513
 
 
514
 
 
515
 
 
516
 
</refentry>