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

   1 <refentry id="modest-modest-account-keys">
   2 <refmeta>
   3 <refentrytitle id="top_of_page">modest-account-keys</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>MODEST Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>modest-account-keys</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 #define     <link linkend="MODEST-CONF-DEFAULT-ACCOUNT:CAPS">MODEST_CONF_DEFAULT_ACCOUNT</link>
  22 #define     <link linkend="MODEST-ACCOUNT-NAMESPACE:CAPS">MODEST_ACCOUNT_NAMESPACE</link>
  23 #define     <link linkend="MODEST-ACCOUNT-DISPLAY-NAME:CAPS">MODEST_ACCOUNT_DISPLAY_NAME</link>
  24 #define     <link linkend="MODEST-ACCOUNT-DEFAULT:CAPS">MODEST_ACCOUNT_DEFAULT</link>
  25 #define     <link linkend="MODEST-ACCOUNT-TYPE:CAPS">MODEST_ACCOUNT_TYPE</link>
  26 #define     <link linkend="MODEST-ACCOUNT-TYPE-STORE:CAPS">MODEST_ACCOUNT_TYPE_STORE</link>
  27 #define     <link linkend="MODEST-ACCOUNT-TYPE-TRANSPORT:CAPS">MODEST_ACCOUNT_TYPE_TRANSPORT</link>
  28 #define     <link linkend="MODEST-ACCOUNT-PROTO:CAPS">MODEST_ACCOUNT_PROTO</link>
  29 #define     <link linkend="MODEST-ACCOUNT-PROTO-POP:CAPS">MODEST_ACCOUNT_PROTO_POP</link>
  30 #define     <link linkend="MODEST-ACCOUNT-PROTO-IMAP:CAPS">MODEST_ACCOUNT_PROTO_IMAP</link>
  31 #define     <link linkend="MODEST-ACCOUNT-PASSWORD:CAPS">MODEST_ACCOUNT_PASSWORD</link>
  32 #define     <link linkend="MODEST-ACCOUNT-SERVER:CAPS">MODEST_ACCOUNT_SERVER</link>
  33 #define     <link linkend="MODEST-ACCOUNT-USER:CAPS">MODEST_ACCOUNT_USER</link>
  34 #define     <link linkend="MODEST-ACCOUNT-LEAVE-ON-SERVER:CAPS">MODEST_ACCOUNT_LEAVE_ON_SERVER</link>
  35 </synopsis>
  36 </refsynopsisdiv>
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46 <refsect1 id="desc">
  47 <title id="desc.title">Description</title>
  48 <para>
  49
  50 </para>
  51 </refsect1>
  52
  53 <refsect1 id="details">
  54 <title id="details.title">Details</title>
  55 <refsect2>
  56 <title><anchor id="MODEST-CONF-DEFAULT-ACCOUNT:CAPS" role="macro"/>MODEST_CONF_DEFAULT_ACCOUNT</title>
  57 <indexterm><primary>MODEST_CONF_DEFAULT_ACCOUNT</primary></indexterm><programlisting>#define MODEST_CONF_DEFAULT_ACCOUNT     "/default_account"
  58 </programlisting>
  59 <para>
  60
  61 </para></refsect2>
  62 <refsect2>
  63 <title><anchor id="MODEST-ACCOUNT-NAMESPACE:CAPS" role="macro"/>MODEST_ACCOUNT_NAMESPACE</title>
  64 <indexterm><primary>MODEST_ACCOUNT_NAMESPACE</primary></indexterm><programlisting>#define MODEST_ACCOUNT_NAMESPACE      MODEST_CONF_NAMESPACE "/" "accounts"
  65 </programlisting>
  66 <para>
  67
  68 </para></refsect2>
  69 <refsect2>
  70 <title><anchor id="MODEST-ACCOUNT-DISPLAY-NAME:CAPS" role="macro"/>MODEST_ACCOUNT_DISPLAY_NAME</title>
  71 <indexterm><primary>MODEST_ACCOUNT_DISPLAY_NAME</primary></indexterm><programlisting>#define MODEST_ACCOUNT_DISPLAY_NAME        "display_name"                  /* string */
  72 </programlisting>
  73 <para>
  74
  75 </para></refsect2>
  76 <refsect2>
  77 <title><anchor id="MODEST-ACCOUNT-DEFAULT:CAPS" role="macro"/>MODEST_ACCOUNT_DEFAULT</title>
  78 <indexterm><primary>MODEST_ACCOUNT_DEFAULT</primary></indexterm><programlisting>#define MODEST_ACCOUNT_DEFAULT          "default"                       /* bool */
  79 </programlisting>
  80 <para>
  81
  82 </para></refsect2>
  83 <refsect2>
  84 <title><anchor id="MODEST-ACCOUNT-TYPE:CAPS" role="macro"/>MODEST_ACCOUNT_TYPE</title>
  85 <indexterm><primary>MODEST_ACCOUNT_TYPE</primary></indexterm><programlisting>#define MODEST_ACCOUNT_TYPE            "type"                      /* string */
  86 </programlisting>
  87 <para>
  88
  89 </para></refsect2>
  90 <refsect2>
  91 <title><anchor id="MODEST-ACCOUNT-TYPE-STORE:CAPS" role="macro"/>MODEST_ACCOUNT_TYPE_STORE</title>
  92 <indexterm><primary>MODEST_ACCOUNT_TYPE_STORE</primary></indexterm><programlisting>#define MODEST_ACCOUNT_TYPE_STORE      "store"
  93 </programlisting>
  94 <para>
  95
  96 </para></refsect2>
  97 <refsect2>
  98 <title><anchor id="MODEST-ACCOUNT-TYPE-TRANSPORT:CAPS" role="macro"/>MODEST_ACCOUNT_TYPE_TRANSPORT</title>
  99 <indexterm><primary>MODEST_ACCOUNT_TYPE_TRANSPORT</primary></indexterm><programlisting>#define MODEST_ACCOUNT_TYPE_TRANSPORT  "transport"
 100 </programlisting>
 101 <para>
 102
 103 </para></refsect2>
 104 <refsect2>
 105 <title><anchor id="MODEST-ACCOUNT-PROTO:CAPS" role="macro"/>MODEST_ACCOUNT_PROTO</title>
 106 <indexterm><primary>MODEST_ACCOUNT_PROTO</primary></indexterm><programlisting>#define MODEST_ACCOUNT_PROTO           "proto"             /* string */
 107 </programlisting>
 108 <para>
 109
 110 </para></refsect2>
 111 <refsect2>
 112 <title><anchor id="MODEST-ACCOUNT-PROTO-POP:CAPS" role="macro"/>MODEST_ACCOUNT_PROTO_POP</title>
 113 <indexterm><primary>MODEST_ACCOUNT_PROTO_POP</primary></indexterm><programlisting>#define MODEST_ACCOUNT_PROTO_POP       "pop"           /* string */
 114 </programlisting>
 115 <para>
 116
 117 </para></refsect2>
 118 <refsect2>
 119 <title><anchor id="MODEST-ACCOUNT-PROTO-IMAP:CAPS" role="macro"/>MODEST_ACCOUNT_PROTO_IMAP</title>
 120 <indexterm><primary>MODEST_ACCOUNT_PROTO_IMAP</primary></indexterm><programlisting>#define MODEST_ACCOUNT_PROTO_IMAP      "imap"                 /* string */
 121 </programlisting>
 122 <para>
 123
 124 </para></refsect2>
 125 <refsect2>
 126 <title><anchor id="MODEST-ACCOUNT-PASSWORD:CAPS" role="macro"/>MODEST_ACCOUNT_PASSWORD</title>
 127 <indexterm><primary>MODEST_ACCOUNT_PASSWORD</primary></indexterm><programlisting>#define MODEST_ACCOUNT_PASSWORD        "password"       /* string */
 128 </programlisting>
 129 <para>
 130
 131 </para></refsect2>
 132 <refsect2>
 133 <title><anchor id="MODEST-ACCOUNT-SERVER:CAPS" role="macro"/>MODEST_ACCOUNT_SERVER</title>
 134 <indexterm><primary>MODEST_ACCOUNT_SERVER</primary></indexterm><programlisting>#define MODEST_ACCOUNT_SERVER          "server"           /* string */
 135 </programlisting>
 136 <para>
 137
 138 </para></refsect2>
 139 <refsect2>
 140 <title><anchor id="MODEST-ACCOUNT-USER:CAPS" role="macro"/>MODEST_ACCOUNT_USER</title>
 141 <indexterm><primary>MODEST_ACCOUNT_USER</primary></indexterm><programlisting>#define MODEST_ACCOUNT_USER            "user"               /* string */
 142 </programlisting>
 143 <para>
 144
 145 </para></refsect2>
 146 <refsect2>
 147 <title><anchor id="MODEST-ACCOUNT-LEAVE-ON-SERVER:CAPS" role="macro"/>MODEST_ACCOUNT_LEAVE_ON_SERVER</title>
 148 <indexterm><primary>MODEST_ACCOUNT_LEAVE_ON_SERVER</primary></indexterm><programlisting>#define     MODEST_ACCOUNT_LEAVE_ON_SERVER</programlisting>
 149 <para>
 150
 151 </para></refsect2>
 152
 153 </refsect1>
 154
 155
 156
 157
 158 </refentry>