git.maemo.org Git - modest/blob - experimental/modest/docs/reference/xml/modest-account-mgr.xml

   1 <refentry id="modest-ModestAccountMgr">
   2 <refmeta>
   3 <refentrytitle id="top_of_page">ModestAccountMgr</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>MODEST Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>ModestAccountMgr</refname>
  10 <refpurpose></refpurpose>
  11 <!--[<xref linkend="desc" endterm="desc.title"/>]-->
  12 </refnamediv>
  13
  14 <refsynopsisdiv id="synopsis">
  15 <title id="synopsis.title">Synopsis</title>
  16
  17 <synopsis>
  18
  19
  20
  21             <link linkend="ModestAccountMgr">ModestAccountMgr</link>;
  22 <link linkend="GObject">GObject</link>*    <link linkend="modest-account-mgr-new">modest_account_mgr_new</link>          (<link linkend="ModestConf">ModestConf</link> *modest_conf);
  23 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-add-account">modest_account_mgr_add_account</link>  (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  24                                              const <link linkend="gchar">gchar</link> *name,
  25                                              <link linkend="GError">GError</link> **err);
  26 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-remove-account">modest_account_mgr_remove_account</link>
  27                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  28                                              const <link linkend="gchar">gchar</link> *name,
  29                                              <link linkend="GError">GError</link> **err);
  30 <link linkend="GSList">GSList</link>*     <link linkend="modest-account-mgr-account-names">modest_account_mgr_account_names</link>
  31                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  32                                              <link linkend="GError">GError</link> **err);
  33 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-account-exists">modest_account_mgr_account_exists</link>
  34                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  35                                              const <link linkend="gchar">gchar</link> *name,
  36                                              <link linkend="GError">GError</link> **err);
  37 <link linkend="gchar">gchar</link>*      <link linkend="modest-account-mgr-get-account-string">modest_account_mgr_get_account_string</link>
  38                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  39                                              const <link linkend="gchar">gchar</link> *name,
  40                                              const <link linkend="gchar">gchar</link> *key,
  41                                              <link linkend="GError">GError</link> **err);
  42 <link linkend="gint">gint</link>        <link linkend="modest-account-mgr-get-account-int">modest_account_mgr_get_account_int</link>
  43                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  44                                              const <link linkend="gchar">gchar</link> *name,
  45                                              const <link linkend="gchar">gchar</link> *key,
  46                                              <link linkend="GError">GError</link> **err);
  47 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-get-account-bool">modest_account_mgr_get_account_bool</link>
  48                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  49                                              const <link linkend="gchar">gchar</link> *name,
  50                                              const <link linkend="gchar">gchar</link> *key,
  51                                              <link linkend="GError">GError</link> **err);
  52 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-set-account-string">modest_account_mgr_set_account_string</link>
  53                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  54                                              const <link linkend="gchar">gchar</link> *name,
  55                                              const <link linkend="gchar">gchar</link> *key,
  56                                              const <link linkend="gchar">gchar</link> *val,
  57                                              <link linkend="GError">GError</link> **err);
  58 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-set-account-int">modest_account_mgr_set_account_int</link>
  59                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  60                                              const <link linkend="gchar">gchar</link> *name,
  61                                              const <link linkend="gchar">gchar</link> *key,
  62                                              <link linkend="gint">gint</link> val,
  63                                              <link linkend="GError">GError</link> **err);
  64 <link linkend="gboolean">gboolean</link>    <link linkend="modest-account-mgr-set-account-bool">modest_account_mgr_set_account_bool</link>
  65                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
  66                                              const <link linkend="gchar">gchar</link> *name,
  67                                              const <link linkend="gchar">gchar</link> *key,
  68                                              <link linkend="gboolean">gboolean</link> val,
  69                                              <link linkend="GError">GError</link> **err);
  70
  71 </synopsis>
  72 </refsynopsisdiv>
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82 <refsect1 id="desc">
  83 <title id="desc.title">Description</title>
  84 <para>
  85
  86 </para>
  87 </refsect1>
  88
  89 <refsect1 id="details">
  90 <title id="details.title">Details</title>
  91 <refsect2>
  92 <title><anchor id="ModestAccountMgr" role="struct"/>ModestAccountMgr</title>
  93 <indexterm><primary>ModestAccountMgr</primary></indexterm><programlisting>typedef struct {
  94          GObject parent;
  95         /* insert public members, if any */
  96 } ModestAccountMgr;
  97 </programlisting>
  98 <para>
  99
 100 </para></refsect2>
 101 <refsect2>
 102 <title><anchor id="modest-account-mgr-new" role="function"/>modest_account_mgr_new ()</title>
 103 <indexterm><primary>modest_account_mgr_new</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*    modest_account_mgr_new          (<link linkend="ModestConf">ModestConf</link> *modest_conf);</programlisting>
 104 <para>
 105 </para>
 106 <para>
 107
 108 </para><variablelist role="params">
 109 <varlistentry><term><parameter>modest_conf</parameter>&nbsp;:</term>
 110 <listitem><simpara> a ModestConf instance
 111 </simpara></listitem></varlistentry>
 112 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new ModestAccountMgr, or NULL in case of error
 113 </simpara></listitem></varlistentry>
 114 </variablelist></refsect2>
 115 <refsect2>
 116 <title><anchor id="modest-account-mgr-add-account" role="function"/>modest_account_mgr_add_account ()</title>
 117 <indexterm><primary>modest_account_mgr_add_account</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_add_account  (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 118                                              const <link linkend="gchar">gchar</link> *name,
 119                                              <link linkend="GError">GError</link> **err);</programlisting>
 120 <para>
 121 create a new account. the account with <parameter>name</parameter> should not already exist</para>
 122 <para>
 123
 124 </para><variablelist role="params">
 125 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 126 <listitem><simpara> a ModestAccountMgr instance
 127 </simpara></listitem></varlistentry>
 128 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 129 <listitem><simpara> the name of the account to create
 130 </simpara></listitem></varlistentry>
 131 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 132 <listitem><simpara> a GError ptr, or NULL to ignore.
 133 </simpara></listitem></varlistentry>
 134 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the creation succeeded, FALSE otherwise,
 135 <parameter>err</parameter> gives details in case of error
 136 </simpara></listitem></varlistentry>
 137 </variablelist></refsect2>
 138 <refsect2>
 139 <title><anchor id="modest-account-mgr-remove-account" role="function"/>modest_account_mgr_remove_account ()</title>
 140 <indexterm><primary>modest_account_mgr_remove_account</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_remove_account
 141                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 142                                              const <link linkend="gchar">gchar</link> *name,
 143                                              <link linkend="GError">GError</link> **err);</programlisting>
 144 <para>
 145 remove an existing account. the account with <parameter>name</parameter> should already exist</para>
 146 <para>
 147
 148 </para><variablelist role="params">
 149 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 150 <listitem><simpara> a ModestAccountMgr instance
 151 </simpara></listitem></varlistentry>
 152 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 153 <listitem><simpara> the name of the account to remove
 154 </simpara></listitem></varlistentry>
 155 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 156 <listitem><simpara> a GError ptr, or NULL to ignore.
 157 </simpara></listitem></varlistentry>
 158 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the creation succeeded, FALSE otherwise,
 159 <parameter>err</parameter> gives details in case of error
 160 </simpara></listitem></varlistentry>
 161 </variablelist></refsect2>
 162 <refsect2>
 163 <title><anchor id="modest-account-mgr-account-names" role="function"/>modest_account_mgr_account_names ()</title>
 164 <indexterm><primary>modest_account_mgr_account_names</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     modest_account_mgr_account_names
 165                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 166                                              <link linkend="GError">GError</link> **err);</programlisting>
 167 <para>
 168 list all account names</para>
 169 <para>
 170
 171 </para><variablelist role="params">
 172 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 173 <listitem><simpara> a ModestAccountMgr instance
 174 </simpara></listitem></varlistentry>
 175 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 176 <listitem><simpara> a GError ptr, or NULL to ignore.
 177 </simpara></listitem></varlistentry>
 178 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated list of account names, or NULL in case of error or
 179 if there are no accounts. The caller must free the returned GSList
 180 <parameter>err</parameter> gives details in case of error
 181 </simpara></listitem></varlistentry>
 182 </variablelist></refsect2>
 183 <refsect2>
 184 <title><anchor id="modest-account-mgr-account-exists" role="function"/>modest_account_mgr_account_exists ()</title>
 185 <indexterm><primary>modest_account_mgr_account_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_account_exists
 186                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 187                                              const <link linkend="gchar">gchar</link> *name,
 188                                              <link linkend="GError">GError</link> **err);</programlisting>
 189 <para>
 190 check whether account <parameter>name</parameter> exists</para>
 191 <para>
 192
 193 </para><variablelist role="params">
 194 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 195 <listitem><simpara> a ModestAccountMgr instance
 196 </simpara></listitem></varlistentry>
 197 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 198 <listitem><simpara>
 199 </simpara></listitem></varlistentry>
 200 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 201 <listitem><simpara> a GError ptr, or NULL to ignore.
 202 </simpara></listitem></varlistentry>
 203 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the account exists, FALSE otherwise (or in case of error)
 204 <parameter>err</parameter> gives details in case of error
 205 </simpara></listitem></varlistentry>
 206 </variablelist></refsect2>
 207 <refsect2>
 208 <title><anchor id="modest-account-mgr-get-account-string" role="function"/>modest_account_mgr_get_account_string ()</title>
 209 <indexterm><primary>modest_account_mgr_get_account_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      modest_account_mgr_get_account_string
 210                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 211                                              const <link linkend="gchar">gchar</link> *name,
 212                                              const <link linkend="gchar">gchar</link> *key,
 213                                              <link linkend="GError">GError</link> **err);</programlisting>
 214 <para>
 215 get a config string from some account</para>
 216 <para>
 217
 218 </para><variablelist role="params">
 219 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 220 <listitem><simpara> self a ModestAccountMgr instance
 221 </simpara></listitem></varlistentry>
 222 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 223 <listitem><simpara> the name of the account
 224 </simpara></listitem></varlistentry>
 225 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 226 <listitem><simpara> the key of the value to retrieve
 227 </simpara></listitem></varlistentry>
 228 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 229 <listitem><simpara> a GError ptr, or NULL to ignore.
 230 </simpara></listitem></varlistentry>
 231 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string with the value for the key,
 232 or NULL in case of error. <parameter>err</parameter> gives details in case of error
 233 </simpara></listitem></varlistentry>
 234 </variablelist></refsect2>
 235 <refsect2>
 236 <title><anchor id="modest-account-mgr-get-account-int" role="function"/>modest_account_mgr_get_account_int ()</title>
 237 <indexterm><primary>modest_account_mgr_get_account_int</primary></indexterm><programlisting><link linkend="gint">gint</link>        modest_account_mgr_get_account_int
 238                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 239                                              const <link linkend="gchar">gchar</link> *name,
 240                                              const <link linkend="gchar">gchar</link> *key,
 241                                              <link linkend="GError">GError</link> **err);</programlisting>
 242 <para>
 243 get a config int from some account</para>
 244 <para>
 245
 246 </para><variablelist role="params">
 247 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 248 <listitem><simpara> self a ModestAccountMgr instance
 249 </simpara></listitem></varlistentry>
 250 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 251 <listitem><simpara> the name of the account
 252 </simpara></listitem></varlistentry>
 253 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 254 <listitem><simpara> the key of the value to retrieve
 255 </simpara></listitem></varlistentry>
 256 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 257 <listitem><simpara> a GError ptr, or NULL to ignore.
 258 </simpara></listitem></varlistentry>
 259 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer with the value for the key, or -1 in case of
 260 error (but of course -1 does not necessarily imply an error)
 261 <parameter>err</parameter> gives details in case of error
 262 </simpara></listitem></varlistentry>
 263 </variablelist></refsect2>
 264 <refsect2>
 265 <title><anchor id="modest-account-mgr-get-account-bool" role="function"/>modest_account_mgr_get_account_bool ()</title>
 266 <indexterm><primary>modest_account_mgr_get_account_bool</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_get_account_bool
 267                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 268                                              const <link linkend="gchar">gchar</link> *name,
 269                                              const <link linkend="gchar">gchar</link> *key,
 270                                              <link linkend="GError">GError</link> **err);</programlisting>
 271 <para>
 272 get a config boolean from some account</para>
 273 <para>
 274
 275 </para><variablelist role="params">
 276 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 277 <listitem><simpara> self a ModestAccountMgr instance
 278 </simpara></listitem></varlistentry>
 279 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 280 <listitem><simpara> the name of the account
 281 </simpara></listitem></varlistentry>
 282 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 283 <listitem><simpara> the key of the value to retrieve
 284 </simpara></listitem></varlistentry>
 285 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 286 <listitem><simpara> a GError ptr, or NULL to ignore.
 287 </simpara></listitem></varlistentry>
 288 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an boolean with the value for the key, or FALSE in case of
 289 error (but of course FALSE does not necessarily imply an error)
 290 <parameter>err</parameter> gives details in case of error
 291 </simpara></listitem></varlistentry>
 292 </variablelist></refsect2>
 293 <refsect2>
 294 <title><anchor id="modest-account-mgr-set-account-string" role="function"/>modest_account_mgr_set_account_string ()</title>
 295 <indexterm><primary>modest_account_mgr_set_account_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_set_account_string
 296                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 297                                              const <link linkend="gchar">gchar</link> *name,
 298                                              const <link linkend="gchar">gchar</link> *key,
 299                                              const <link linkend="gchar">gchar</link> *val,
 300                                              <link linkend="GError">GError</link> **err);</programlisting>
 301 <para>
 302 set a config string for some account</para>
 303 <para>
 304
 305 </para><variablelist role="params">
 306 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 307 <listitem><simpara> self a ModestAccountMgr instance
 308 </simpara></listitem></varlistentry>
 309 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 310 <listitem><simpara> the name of the account
 311 </simpara></listitem></varlistentry>
 312 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 313 <listitem><simpara> the key of the value to set
 314 </simpara></listitem></varlistentry>
 315 <varlistentry><term><parameter>val</parameter>&nbsp;:</term>
 316 <listitem><simpara> the value to set
 317 </simpara></listitem></varlistentry>
 318 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 319 <listitem><simpara> a GError ptr, or NULL to ignore.
 320 </simpara></listitem></varlistentry>
 321 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if setting the value succeeded, or FALSE in case of error.
 322 <parameter>err</parameter> gives details in case of error
 323 </simpara></listitem></varlistentry>
 324 </variablelist></refsect2>
 325 <refsect2>
 326 <title><anchor id="modest-account-mgr-set-account-int" role="function"/>modest_account_mgr_set_account_int ()</title>
 327 <indexterm><primary>modest_account_mgr_set_account_int</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_set_account_int
 328                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 329                                              const <link linkend="gchar">gchar</link> *name,
 330                                              const <link linkend="gchar">gchar</link> *key,
 331                                              <link linkend="gint">gint</link> val,
 332                                              <link linkend="GError">GError</link> **err);</programlisting>
 333 <para>
 334 set a config int for some account</para>
 335 <para>
 336
 337 </para><variablelist role="params">
 338 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 339 <listitem><simpara> self a ModestAccountMgr instance
 340 </simpara></listitem></varlistentry>
 341 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 342 <listitem><simpara> the name of the account
 343 </simpara></listitem></varlistentry>
 344 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 345 <listitem><simpara> the key of the value to set
 346 </simpara></listitem></varlistentry>
 347 <varlistentry><term><parameter>val</parameter>&nbsp;:</term>
 348 <listitem><simpara> the value to set
 349 </simpara></listitem></varlistentry>
 350 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 351 <listitem><simpara> a GError ptr, or NULL to ignore.
 352 </simpara></listitem></varlistentry>
 353 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if setting the value succeeded, or FALSE in case of error.
 354 <parameter>err</parameter> gives details in case of error
 355 </simpara></listitem></varlistentry>
 356 </variablelist></refsect2>
 357 <refsect2>
 358 <title><anchor id="modest-account-mgr-set-account-bool" role="function"/>modest_account_mgr_set_account_bool ()</title>
 359 <indexterm><primary>modest_account_mgr_set_account_bool</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_account_mgr_set_account_bool
 360                                             (<link linkend="ModestAccountMgr">ModestAccountMgr</link> *self,
 361                                              const <link linkend="gchar">gchar</link> *name,
 362                                              const <link linkend="gchar">gchar</link> *key,
 363                                              <link linkend="gboolean">gboolean</link> val,
 364                                              <link linkend="GError">GError</link> **err);</programlisting>
 365 <para>
 366 set a config bool for some account</para>
 367 <para>
 368
 369 </para><variablelist role="params">
 370 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 371 <listitem><simpara> self a ModestAccountMgr instance
 372 </simpara></listitem></varlistentry>
 373 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 374 <listitem><simpara> the name of the account
 375 </simpara></listitem></varlistentry>
 376 <varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 377 <listitem><simpara> the key of the value to set
 378 </simpara></listitem></varlistentry>
 379 <varlistentry><term><parameter>val</parameter>&nbsp;:</term>
 380 <listitem><simpara> the value to set
 381 </simpara></listitem></varlistentry>
 382 <varlistentry><term><parameter>err</parameter>&nbsp;:</term>
 383 <listitem><simpara> a GError ptr, or NULL to ignore.
 384 </simpara></listitem></varlistentry>
 385 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if setting the value succeeded, or FALSE in case of error.
 386 <parameter>err</parameter> gives details in case of error
 387 </simpara></listitem></varlistentry>
 388 </variablelist></refsect2>
 389
 390 </refsect1>
 391
 392
 393
 394
 395 </refentry>