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
|
<refentry id="gmime-gmime-message-partial">
<refmeta>
<refentrytitle>gmime-message-partial</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gmime-message-partial</refname><refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<anchor id="GMimeMessagePartial"/>
<synopsis>
<link linkend="GMimeMessagePartial-struct">GMimeMessagePartial</link>;
<link linkend="GMimeMessagePartial">GMimeMessagePartial</link>* <link linkend="g-mime-message-partial-new">g_mime_message_partial_new</link>
(const <link linkend="char">char</link> *id,
<link linkend="int">int</link> number,
<link linkend="int">int</link> total);
const <link linkend="char">char</link>* <link linkend="g-mime-message-partial-get-id">g_mime_message_partial_get_id</link> (<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> *partial);
<link linkend="int">int</link> <link linkend="g-mime-message-partial-get-number">g_mime_message_partial_get_number</link>
(<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> *partial);
<link linkend="int">int</link> <link linkend="g-mime-message-partial-get-total">g_mime_message_partial_get_total</link>
(<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> *partial);
<link linkend="GMimeMessage">GMimeMessage</link>* <link linkend="g-mime-message-partial-reconstruct-message">g_mime_message_partial_reconstruct_message</link>
(<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> **partials,
<link linkend="size-t">size_t</link> num);
<link linkend="GMimeMessage">GMimeMessage</link>** <link linkend="g-mime-message-partial-split-message">g_mime_message_partial_split_message</link>
(<link linkend="GMimeMessage">GMimeMessage</link> *message,
<link linkend="size-t">size_t</link> max_size,
<link linkend="size-t">size_t</link> *nparts);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GMimeObject">GMimeObject</link>
+----<link linkend="GMimePart">GMimePart</link>
+----GMimeMessagePartial
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimeMessagePartial-struct"/>GMimeMessagePartial</title>
<indexterm><primary>GMimeMessagePartial</primary></indexterm><programlisting>typedef struct _GMimeMessagePartial GMimeMessagePartial;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="g-mime-message-partial-new"/>g_mime_message_partial_new ()</title>
<indexterm><primary>g_mime_message_partial_new</primary></indexterm><programlisting><link linkend="GMimeMessagePartial">GMimeMessagePartial</link>* g_mime_message_partial_new
(const <link linkend="char">char</link> *id,
<link linkend="int">int</link> number,
<link linkend="int">int</link> total);</programlisting>
<para>
Creates a new MIME message/partial object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> message/partial part id
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>number</parameter> :</term>
<listitem><simpara> message/partial part number
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>total</parameter> :</term>
<listitem><simpara> total number of message/partial parts
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>an empty MIME message/partial object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-message-partial-get-id"/>g_mime_message_partial_get_id ()</title>
<indexterm><primary>g_mime_message_partial_get_id</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_message_partial_get_id (<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> *partial);</programlisting>
<para>
Gets the message/partial id parameter value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>partial</parameter> :</term>
<listitem><simpara> message/partial object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the message/partial id or <literal>NULL</literal> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-message-partial-get-number"/>g_mime_message_partial_get_number ()</title>
<indexterm><primary>g_mime_message_partial_get_number</primary></indexterm><programlisting><link linkend="int">int</link> g_mime_message_partial_get_number
(<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> *partial);</programlisting>
<para>
Gets the message/partial part number.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>partial</parameter> :</term>
<listitem><simpara> message/partial object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the message/partial part number or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-message-partial-get-total"/>g_mime_message_partial_get_total ()</title>
<indexterm><primary>g_mime_message_partial_get_total</primary></indexterm><programlisting><link linkend="int">int</link> g_mime_message_partial_get_total
(<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> *partial);</programlisting>
<para>
Gets the total number of message/partial parts needed to
reconstruct the original message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>partial</parameter> :</term>
<listitem><simpara> message/partial object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the total number of message/partial parts needed to
reconstruct the original message or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-message-partial-reconstruct-message"/>g_mime_message_partial_reconstruct_message ()</title>
<indexterm><primary>g_mime_message_partial_reconstruct_message</primary></indexterm><programlisting><link linkend="GMimeMessage">GMimeMessage</link>* g_mime_message_partial_reconstruct_message
(<link linkend="GMimeMessagePartial">GMimeMessagePartial</link> **partials,
<link linkend="size-t">size_t</link> num);</programlisting>
<para>
Reconstructs the GMimeMessage from the given message/partial parts
in <parameter>partials</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>partials</parameter> :</term>
<listitem><simpara> an array of message/partial mime parts
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num</parameter> :</term>
<listitem><simpara> the number of elements in <parameter>partials</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a GMimeMessage object on success or <literal>NULL</literal> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-message-partial-split-message"/>g_mime_message_partial_split_message ()</title>
<indexterm><primary>g_mime_message_partial_split_message</primary></indexterm><programlisting><link linkend="GMimeMessage">GMimeMessage</link>** g_mime_message_partial_split_message
(<link linkend="GMimeMessage">GMimeMessage</link> *message,
<link linkend="size-t">size_t</link> max_size,
<link linkend="size-t">size_t</link> *nparts);</programlisting>
<para>
Splits <parameter>message</parameter> into an array of <link linkend="GMimeMessage"><type>GMimeMessage</type></link> objects each
containing a single <link linkend="GMimeMessagePartial"><type>GMimeMessagePartial</type></link> object containing
<parameter>max_size</parameter> bytes or fewer. <parameter>nparts</parameter> is set to the number of
<link linkend="GMimeMessagePartial"><type>GMimeMessagePartial</type></link> objects created.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara> message object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_size</parameter> :</term>
<listitem><simpara> max size
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nparts</parameter> :</term>
<listitem><simpara> number of parts
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>an array of <link linkend="GMimeMessage"><type>GMimeMessage</type></link> objects and sets <parameter>nparts</parameter> to th
number of messages returned or <literal>NULL</literal> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
