<?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>&nbsp;:</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>&nbsp;:</term>
<listitem><simpara> an XML account description
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</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>&nbsp;:</term>
<listitem><simpara> an <link linkend="EAccount"><type>EAccount</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xml</parameter>&nbsp;:</term>
<listitem><simpara> an XML account description.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</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>&nbsp;:</term>
<listitem><simpara> destination account object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src</parameter>&nbsp;:</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>&nbsp;:</term>
<listitem><simpara> an <link linkend="EAccount"><type>EAccount</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</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>&nbsp;:</term>
<listitem><simpara> an XML account description
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</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>
