daf86521133c919018ddc3b2090de9d346b49b24
[modest] / docs / reference / tmpl / modest-account-mgr.sgml
1 <!-- ##### SECTION Title ##### -->
2 ModestAccountMgr
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Manage user and server accounts
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 This module is used to add/remove modest mail accounts and the server accounts
10 assigned to them. It is used to change account details and provides a complete 
11 abstraction of the configuration backend used to store the account data.
12 </para>
13
14 <!-- ##### SECTION See_Also ##### -->
15 <para>
16
17 </para>
18
19 <!-- ##### SECTION Stability_Level ##### -->
20
21
22 <!-- ##### STRUCT ModestAccountMgr ##### -->
23 <para>
24
25 </para>
26
27 @parent: 
28
29 <!-- ##### FUNCTION modest_account_mgr_new ##### -->
30 <para>
31
32 </para>
33
34 @modest_conf: 
35 @Returns: 
36
37
38 <!-- ##### FUNCTION modest_account_mgr_add_account ##### -->
39 <para>
40
41 </para>
42
43 @self: 
44 @name: 
45 @store_name: 
46 @transport_name: 
47 @err: 
48 @Returns: 
49
50
51 <!-- ##### FUNCTION modest_account_mgr_remove_account ##### -->
52 <para>
53
54 </para>
55
56 @self: 
57 @name: 
58 @err: 
59 @Returns: 
60
61
62 <!-- ##### FUNCTION modest_account_mgr_add_server_account ##### -->
63 <para>
64
65 </para>
66
67 @self: 
68 @name: 
69 @hostname: 
70 @username: 
71 @password: 
72 @proto: 
73 @Returns: 
74
75
76 <!-- ##### FUNCTION modest_account_mgr_remove_server_account ##### -->
77 <para>
78
79 </para>
80
81 @self: 
82 @name: 
83 @err: 
84 @Returns: 
85
86
87 <!-- ##### FUNCTION modest_account_mgr_account_names ##### -->
88 <para>
89
90 </para>
91
92 @self: 
93 @err: 
94 @Returns: 
95
96
97 <!-- ##### FUNCTION modest_account_mgr_server_account_names ##### -->
98 <para>
99
100 </para>
101
102 @self: 
103 @account_name: 
104 @type: 
105 @proto: 
106 @only_enabled: 
107 @Returns: 
108
109
110 <!-- ##### FUNCTION modest_account_mgr_account_exists ##### -->
111 <para>
112
113 </para>
114
115 @self: 
116 @name: 
117 @err: 
118 @Returns: 
119
120
121 <!-- ##### FUNCTION modest_account_mgr_server_account_exists ##### -->
122 <para>
123
124 </para>
125
126 @self: 
127 @name: 
128 @err: 
129 @Returns: 
130
131
132 <!-- ##### FUNCTION modest_account_mgr_get_account_string ##### -->
133 <para>
134
135 </para>
136
137 @self: 
138 @name: 
139 @key: 
140 @err: 
141 @Returns: 
142
143
144 <!-- ##### FUNCTION modest_account_mgr_get_server_account_string ##### -->
145 <para>
146
147 </para>
148
149 @self: 
150 @name: 
151 @key: 
152 @err: 
153 @Returns: 
154
155
156 <!-- ##### FUNCTION modest_account_mgr_get_account_int ##### -->
157 <para>
158
159 </para>
160
161 @self: 
162 @name: 
163 @key: 
164 @err: 
165 @Returns: 
166
167
168 <!-- ##### FUNCTION modest_account_mgr_get_server_account_int ##### -->
169 <para>
170
171 </para>
172
173 @self: 
174 @name: 
175 @key: 
176 @err: 
177 @Returns: 
178
179
180 <!-- ##### FUNCTION modest_account_mgr_get_account_bool ##### -->
181 <para>
182
183 </para>
184
185 @self: 
186 @name: 
187 @key: 
188 @err: 
189 @Returns: 
190
191
192 <!-- ##### FUNCTION modest_account_mgr_get_server_account_bool ##### -->
193 <para>
194
195 </para>
196
197 @self: 
198 @name: 
199 @key: 
200 @err: 
201 @Returns: 
202
203
204 <!-- ##### FUNCTION modest_account_mgr_set_account_string ##### -->
205 <para>
206
207 </para>
208
209 @self: 
210 @name: 
211 @key: 
212 @val: 
213 @err: 
214 @Returns: 
215
216
217 <!-- ##### FUNCTION modest_account_mgr_set_server_account_string ##### -->
218 <para>
219
220 </para>
221
222 @self: 
223 @name: 
224 @key: 
225 @val: 
226 @err: 
227 @Returns: 
228
229
230 <!-- ##### FUNCTION modest_account_mgr_set_account_int ##### -->
231 <para>
232
233 </para>
234
235 @self: 
236 @name: 
237 @key: 
238 @val: 
239 @err: 
240 @Returns: 
241
242
243 <!-- ##### FUNCTION modest_account_mgr_set_server_account_int ##### -->
244 <para>
245
246 </para>
247
248 @self: 
249 @name: 
250 @key: 
251 @val: 
252 @err: 
253 @Returns: 
254
255
256 <!-- ##### FUNCTION modest_account_mgr_set_account_bool ##### -->
257 <para>
258
259 </para>
260
261 @self: 
262 @name: 
263 @key: 
264 @val: 
265 @err: 
266 @Returns: 
267
268
269 <!-- ##### FUNCTION modest_account_mgr_set_server_account_bool ##### -->
270 <para>
271
272 </para>
273
274 @self: 
275 @name: 
276 @key: 
277 @val: 
278 @err: 
279 @Returns: