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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-EAccount">
<refmeta>
<refentrytitle role="top_of_page">EAccount</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EAccount</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="EAccountIdentity">EAccountIdentity</link>;
<link linkend="EAccountService">EAccountService</link>;
<link linkend="EAccount">EAccount</link>* <link linkend="e-account-new">e_account_new</link> (void);
<link linkend="EAccount">EAccount</link>* <link linkend="e-account-new-from-xml">e_account_new_from_xml</link> (const <link linkend="char">char</link> *xml);
<link linkend="gboolean">gboolean</link> <link linkend="e-account-set-from-xml">e_account_set_from_xml</link> (<link linkend="EAccount">EAccount</link> *account,
const <link linkend="char">char</link> *xml);
<link linkend="void">void</link> <link linkend="e-account-import">e_account_import</link> (<link linkend="EAccount">EAccount</link> *dest,
<link linkend="EAccount">EAccount</link> *src);
<link linkend="char">char</link>* <link linkend="e-account-to-xml">e_account_to_xml</link> (<link linkend="EAccount">EAccount</link> *account);
<link linkend="char">char</link>* <link linkend="e-account-uid-from-xml">e_account_uid_from_xml</link> (const <link linkend="char">char</link> *xml);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EAccountIdentity" role="struct"/>EAccountIdentity</title>
<indexterm><primary>EAccountIdentity</primary></indexterm><programlisting>typedef struct {
char *name;
char *address;
char *reply_to;
char *organization;
char *sig_uid;
} EAccountIdentity;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="EAccountService" role="struct"/>EAccountService</title>
<indexterm><primary>EAccountService</primary></indexterm><programlisting>typedef struct {
char *url;
gboolean keep_on_server;
gboolean auto_check;
int auto_check_time;
gboolean save_passwd;
} EAccountService;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-account-new" role="function"/>e_account_new ()</title>
<indexterm><primary>e_account_new</primary></indexterm><programlisting><link linkend="EAccount">EAccount</link>* e_account_new (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a blank new account which can be filled in and
added to an <link linkend="EAccountList"><type>EAccountList</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-new-from-xml" role="function"/>e_account_new_from_xml ()</title>
<indexterm><primary>e_account_new_from_xml</primary></indexterm><programlisting><link linkend="EAccount">EAccount</link>* e_account_new_from_xml (const <link linkend="char">char</link> *xml);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml</parameter> :</term>
<listitem><simpara> an XML account description
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="EAccount"><type>EAccount</type></link> based on the data in <parameter>xml</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if <parameter>xml</parameter> could not be parsed as valid account data.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-set-from-xml" role="function"/>e_account_set_from_xml ()</title>
<indexterm><primary>e_account_set_from_xml</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_account_set_from_xml (<link linkend="EAccount">EAccount</link> *account,
const <link linkend="char">char</link> *xml);</programlisting>
<para>
Changes <parameter>account</parameter> to match <parameter>xml</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>account</parameter> :</term>
<listitem><simpara> an <link linkend="EAccount"><type>EAccount</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xml</parameter> :</term>
<listitem><simpara> an XML account description.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>account</parameter> was changed, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if <parameter>account</parameter>
already matched <parameter>xml</parameter> or <parameter>xml</parameter> could not be parsed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-import" role="function"/>e_account_import ()</title>
<indexterm><primary>e_account_import</primary></indexterm><programlisting><link linkend="void">void</link> e_account_import (<link linkend="EAccount">EAccount</link> *dest,
<link linkend="EAccount">EAccount</link> *src);</programlisting>
<para>
Import the settings from <parameter>src</parameter> to <parameter>dest</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dest</parameter> :</term>
<listitem><simpara> destination account object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> source account object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-to-xml" role="function"/>e_account_to_xml ()</title>
<indexterm><primary>e_account_to_xml</primary></indexterm><programlisting><link linkend="char">char</link>* e_account_to_xml (<link linkend="EAccount">EAccount</link> *account);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>account</parameter> :</term>
<listitem><simpara> an <link linkend="EAccount"><type>EAccount</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an XML representation of <parameter>account</parameter>, which the caller
must free.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-uid-from-xml" role="function"/>e_account_uid_from_xml ()</title>
<indexterm><primary>e_account_uid_from_xml</primary></indexterm><programlisting><link linkend="char">char</link>* e_account_uid_from_xml (const <link linkend="char">char</link> *xml);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml</parameter> :</term>
<listitem><simpara> an XML account description
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the permanent UID of the account described by <parameter>xml</parameter>
(or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>xml</parameter> could not be parsed or did not contain a uid).
The caller must free this string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
