1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
<refentry id="gmime-gmime-header" revision="2 Mar 2002">
<refmeta>
<refentrytitle>gmime-header</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gmime-header</refname><refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
void (<link linkend="GMimeHeaderFunc">*GMimeHeaderFunc</link>) (const char *name,
const char *value,
<link linkend="gpointer">gpointer</link> data);
<link linkend="GMimeHeader">GMimeHeader</link>* <link linkend="g-mime-header-new">g_mime_header_new</link> (void);
void <link linkend="g-mime-header-destroy">g_mime_header_destroy</link> (<link linkend="GMimeHeader">GMimeHeader</link> *header);
void <link linkend="g-mime-header-add">g_mime_header_add</link> (<link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name,
const char *value);
void <link linkend="g-mime-header-set">g_mime_header_set</link> (<link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name,
const char *value);
const char* <link linkend="g-mime-header-get">g_mime_header_get</link> (const <link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name);
void <link linkend="g-mime-header-remove">g_mime_header_remove</link> (<link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name);
void <link linkend="g-mime-header-write-to-stream">g_mime_header_write_to_stream</link> (const <link linkend="GMimeHeader">GMimeHeader</link> *header,
<link linkend="GMimeStream">GMimeStream</link> *stream);
char* <link linkend="g-mime-header-to-string">g_mime_header_to_string</link> (const <link linkend="GMimeHeader">GMimeHeader</link> *header);
void <link linkend="g-mime-header-foreach">g_mime_header_foreach</link> (const <link linkend="GMimeHeader">GMimeHeader</link> *header,
<link linkend="GMimeHeaderFunc">GMimeHeaderFunc</link> func,
<link linkend="gpointer">gpointer</link> data);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimeHeaderFunc">GMimeHeaderFunc ()</title>
<programlisting>void (*GMimeHeaderFunc) (const char *name,
const char *value,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>name</parameter> :</entry>
<entry></entry></row>
<row><entry align="right"><parameter>value</parameter> :</entry>
<entry></entry></row>
<row><entry align="right"><parameter>data</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-new">g_mime_header_new ()</title>
<programlisting><link linkend="GMimeHeader">GMimeHeader</link>* g_mime_header_new (void);</programlisting>
<para>
Creates a new GMimeHeader object.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new header object.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-destroy">g_mime_header_destroy ()</title>
<programlisting>void g_mime_header_destroy (<link linkend="GMimeHeader">GMimeHeader</link> *header);</programlisting>
<para>
Destroy the header object</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-add">g_mime_header_add ()</title>
<programlisting>void g_mime_header_add (<link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name,
const char *value);</programlisting>
<para>
Adds a header. If <parameter>value</parameter> is <literal>NULL</literal>, a space will be set aside for it
(useful for setting the order of headers before values can be
obtained for them) otherwise the header will be unset.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><parameter>name</parameter> :</entry>
<entry> header name
</entry></row>
<row><entry align="right"><parameter>value</parameter> :</entry>
<entry> header value
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-set">g_mime_header_set ()</title>
<programlisting>void g_mime_header_set (<link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name,
const char *value);</programlisting>
<para>
Set the value of the specified header. If <parameter>value</parameter> is <literal>NULL</literal> and the
header, <parameter>name</parameter>, had not been previously set, a space will be set
aside for it (useful for setting the order of headers before values
can be obtained for them) otherwise the header will be unset.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><parameter>name</parameter> :</entry>
<entry> header name
</entry></row>
<row><entry align="right"><parameter>value</parameter> :</entry>
<entry> header value
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-get">g_mime_header_get ()</title>
<programlisting>const char* g_mime_header_get (const <link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name);</programlisting>
<para>
Gets the value of the header requested.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><parameter>name</parameter> :</entry>
<entry> header name
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>the value of the header requested.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-remove">g_mime_header_remove ()</title>
<programlisting>void g_mime_header_remove (<link linkend="GMimeHeader">GMimeHeader</link> *header,
const char *name);</programlisting>
<para>
Remove the specified header.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><parameter>name</parameter> :</entry>
<entry> header name
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-write-to-stream">g_mime_header_write_to_stream ()</title>
<programlisting>void g_mime_header_write_to_stream (const <link linkend="GMimeHeader">GMimeHeader</link> *header,
<link linkend="GMimeStream">GMimeStream</link> *stream);</programlisting>
<para>
Write the headers to a stream.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><parameter>stream</parameter> :</entry>
<entry> output stream
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-to-string">g_mime_header_to_string ()</title>
<programlisting>char* g_mime_header_to_string (const <link linkend="GMimeHeader">GMimeHeader</link> *header);</programlisting>
<para>
Allocates a string buffer containing the raw rfc822 headers
contained in <parameter>header</parameter>.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a string containing the header block
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-header-foreach">g_mime_header_foreach ()</title>
<programlisting>void g_mime_header_foreach (const <link linkend="GMimeHeader">GMimeHeader</link> *header,
<link linkend="GMimeHeaderFunc">GMimeHeaderFunc</link> func,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Calls <parameter>func</parameter> for each header name/value pair.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>header</parameter> :</entry>
<entry> header object
</entry></row>
<row><entry align="right"><parameter>func</parameter> :</entry>
<entry> function to be called for each header.
</entry></row>
<row><entry align="right"><parameter>data</parameter> :</entry>
<entry> User data to be passed to the func.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
</refsect1>
</refentry>
|
