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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
/*
* email-service
*
* Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
*
* Contact: Kyuho Jo <kyuho.jo@samsung.com>, Sunghyun Kwon <sh0701.kwon@samsung.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef __EMAIL_API_MAILBOX_H__
#define __EMAIL_API_MAILBOX_H__
#include "email-types.h"
/**
* @defgroup EMAIL_SERVICE Email Service
* @{
*/
/**
* @ingroup EMAIL_SERVICE
* @defgroup EMAIL_API_MAILBOX Email Mailbox API
* @{
*/
/**
*
* This file contains the data structures and interfaces needed for application,
* to interact with email-service.
* @file email-api-mailbox.h
* @author Kyuho Jo <kyuho.jo@samsung.com>
* @author Sunghyun Kwon <sh0701.kwon@samsung.com>
* @version 0.1
* @brief This file contains the data structures and interfaces of mailbox provided by
* email-service .
* @{
* @code
*
* #include "email_api_mailbox.h"
*
* bool other_app_invoke_uniform_api_sample(int *error_code)
* {
* email_mailbox_t mailbox;
* email_mailbox_t *new_mailbox =NULL;
* email_mailbox_t *mailbox_list = NULL;
* int count = 0;
* int mailbox_type;
* unsigned handle = 0;
* char *pMaiboxName;
* char *pParentMailbox;
*
* memset(&mailbox,0x00,sizeof(email_mailbox_t));
* mailbox.mailbox_name = strdup("test");
* mailbox.alias = strdup("Personal");
* mailbox.account_id = 1;
* printf("Enter local_yn(1/0)");
* scanf("%d",&local_yn);
* mailbox.local=local_yn;
* mailbox.mailbox_type = 7;
*
* //create new mailbox
*
* if(EMAIL_ERR_NONE != email_add_mailbox(&mailbox,local_yn,&handle))
* printf("email_add_mailbox failed\n");
* else
* printf("email_add_mailbox success");
*
* //delete mailbox
*
* if(EMAIL_ERROR_NONE != email_delete_mailbox(mailbox,local_yn,&handle))
* printf("email_delete_mailbox failed\n");
* else
* printf("email_delete_mailbox success\n");
*
* //free mailbox
* email_free_mailbox("new_mailbox,1");
*
* //Get mailbox list
* if(EMAIL_ERROR_NONE != email_get_mailbox_list(account_id,local_yn,&mailbox_list,&count))
* //failure
* else
* //success
*
* //Get mailbox by name
* pMailboxName = strdup("test");
* if(EMAIL_ERROR_NONE != email_get_mailbox_by_name(account_id,pMailboxName,&mailbox_list))
* //failure
* else
* //success
*
* //Get child mailbox list
* pParentMailbox = strdup("test");
* if(EMAIL_ERROR_NONE != email_get_child_mailbox_list(account_id, paerent_mailbox,&mailbox_list,&count))
* //failure
* else
* //success
*
* //Get mailbox by mailbox_type
* printf("Enter mailbox_type\n");
* scanf("%d",&mailbox_type);
* if(EMAIL_ERROR_NONE != email_get_mailbox_by_mailbox_type(account_id,mailbox_type,&mailbox_list))
* //failure
* else
* //success
*
* }
*
* @endcode
* @}
*/
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
/**
* @open
* @fn int email_add_mailbox(email_mailbox_t* new_mailbox, int on_server, unsigned* handle)
* @brief Create a new mailbox or mailbox.This function is invoked when user wants to create a new mailbox for the specified account.
* If On_server is true then it will create the mailbox on server as well as in local also.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] new_mailbox Specifies the pointer of creating mailbox information.
* @param[in] on_server Specifies the creating mailbox on server.
* @param[out] handle Specifies the sending handle.
* @exception none
* @see email_mailbox_t
* @remarks N/A
*/
EXPORT_API int email_add_mailbox(email_mailbox_t *new_mailbox, int on_server, unsigned* handle);
/**
* @fn int email_rename_mailbox(int input_mailbox_id, char *input_mailbox_name, char *input_mailbox_alias)
* @brief Change mailbox name. This function is invoked when user wants to change the name of existing mail box.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] input_mailbox_id Specifies the id of the mailbox.
* @param[in] input_mailbox_name Specifies the name of the mailbox.
* @param[in] input_mailbox_alias Specifies the alias of the mailbox.
* @param[in] input_on_server Specifies the moving mailbox on server.
* @param[out] output_handle Specifies the handle to manage tasks.
*
* @exception see email-errors.h
* @see email_mailbox_t, email_mailbox_type_e
* @remarks N/A
*/
EXPORT_API int email_rename_mailbox(int input_mailbox_id, char *input_mailbox_name, char *input_mailbox_alias, int input_on_server, unsigned *output_handle);
/**
* @open
* @fn int email_delete_mailbox(int input_mailbox_id, int input_on_server, unsigned* output_handle)
* @brief Delete a mailbox or mailbox.This function deletes the existing mailbox for specified account based on the option on_server.
* If the on_server is true then it deletes mailbox from server as well as locally.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] input_mailbox_id Specifies the id of target mailbox .
* @param[in] input_on_server Specifies the deleting mailbox on server.
* @param[out] output_handle Specifies the sending handle.
* @exception see email-errors.h
* @see email_mailbox_t
* @remarks N/A
*/
EXPORT_API int email_delete_mailbox(int input_mailbox_id, int input_on_server, unsigned* output_handle);
/**
* @fn int email_set_mailbox_type(int input_mailbox_id, email_mailbox_type_e input_mailbox_type)
* @brief Change the mailbox type. This function is invoked when user wants to change the mailbox type.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] input_mailbox_id Specifies the id of the mailbox.
* @param[in] input_mailbox_type Specifies the mailbox type.
* @exception see email-errors.h
* @see email_mailbox_type_e
* @remarks N/A
*/
EXPORT_API int email_set_mailbox_type(int input_mailbox_id, email_mailbox_type_e input_mailbox_type);
/**
* @open
* @fn email_get_mailbox_list(int account_id, int mailbox_sync_type, email_mailbox_t** mailbox_list, int* count)
* @brief Get all mailboxes from account.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] account_id Specifies the account ID.
* @param[in] mailbox_sync_type Specifies the sync type.
* @param[out] mailbox_list Specifies the pointer of mailbox structure pointer.(possibly NULL)
* @param[out] count The mailbox count is saved here.(possibly 0)
* @exception none
* @see email_mailbox_t
* @code
* #include "email-api-mailbox.h"
* bool
* _api_sample_get_mailbox_list()
* {
* int account_id =0,count = 0;
* int mailbox_sync_type;
* int error_code = EMAIL_ERROR_NONE;
* email_mailbox_t *mailbox_list=NULL;
*
* printf("\n > Enter account id: ");
* scanf("%d", &account_id);
* printf("\n > Enter mailbox_sync_type: ");
* scanf("%d", &mailbox_sync_type);
*
* if((EMAIL_ERROR_NONE != email_get_mailbox_list(account_id, mailbox_sync_type, &mailbox_list, &count)))
* {
* printf(" Error\n");
* }
* else
* {
* printf("Success\n");
* email_free_mailbox(&mailbox_list,count);
* }
* }
* @endcode
* @remarks N/A
*/
EXPORT_API int email_get_mailbox_list(int account_id, int mailbox_sync_type, email_mailbox_t** mailbox_list, int* count);
EXPORT_API int email_get_mailbox_list_ex(int account_id, int mailbox_sync_type, int with_count, email_mailbox_t** mailbox_list, int* count);
/**
* @open
* @fn email_get_mailbox_by_mailbox_type(int account_id, email_mailbox_type_e mailbox_type, email_mailbox_t** mailbox)
* @brief Get mailbox by mailbox_type.This function is invoked when user wants to know the mailbox information by mailbox_type for the given account.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] account_id Specifies the account ID.
* @param[in] mailbox_type Specifies the mailbox type.
* @param[out] mailbox Specifies the pointer of mailbox structure pointer.(possibly NULL)
* @exception none
* @see email_mailbox_t
* @remarks N/A
*/
EXPORT_API int email_get_mailbox_by_mailbox_type(int account_id, email_mailbox_type_e mailbox_type, email_mailbox_t** mailbox);
/**
* @open
* @fn email_get_mailbox_by_mailbox_id(int input_mailbox_id, email_mailbox_t** output_mailbox)
* @brief Get mailbox by mailbox_id. This function is invoked when user wants to know the mailbox information by mailbox id.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] input_mailbox_id Specifies the mailbox id.
* @param[out] output_mailbox Specifies the pointer of mailbox structure pointer.(possibly NULL)
* @exception none
* @see email_mailbox_t
* @remarks N/A
*/
EXPORT_API int email_get_mailbox_by_mailbox_id(int input_mailbox_id, email_mailbox_t** output_mailbox);
/**
* @open
* @fn email_set_mail_slot_size(int input_account_id, int input_mailbox_id, int input_new_slot_size)
* @brief Set mail slot size.This function is invoked when user wants to set the size of mail slot.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] input_account_id Specifies the account ID.
* @param[in] input_mailbox_id Specifies the mailbox id.
* @param[in] input_new_slot_size Specifies the mail slot size.
* @exception none
* @see email_mailbox_t
* @remarks N/A
*/
EXPORT_API int email_set_mail_slot_size(int input_account_id, int input_mailbox_id, int input_new_slot_size);
/**
* @open
* @fn email_stamp_sync_time_of_mailbox(int input_mailbox_id)
* @brief Stamp sync time of mailbox. This function is invoked when user wants to set the sync time of the mailbox.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code(refer to EMAIL_ERROR_XXX) on failure.
* @param[in] input_mailbox_id Specifies the mailbox id.
* @exception none
* @see email_mailbox_t
* @remarks N/A
*/
EXPORT_API int email_stamp_sync_time_of_mailbox(int input_mailbox_id);
/**
* @open
* @fn email_free_mailbox(email_mailbox_t** mailbox_list, int count)
* @brief Free allocated memory for mailbox information.
*
* @return This function returns EMAIL_ERROR_NONE on success or error code (refer to EMAIL_ERROR_XXX) on failure.
* @param[in] mailbox_list Specifies the pointer for searching mailbox structure pointer.
* @param[in] count Specifies the count of mailboxes.
* @exception none
* @see email_mailbox_t
* @code
* #include "email-api-mailbox.h"
* bool
* _api_sample_free_mailbox_info()
* {
* email_mailbox_t *mailbox;
*
* //fill the mailbox structure
* //count - number of mailbox structure user want to free
* if(EMAIL_ERROR_NONE == email_free_mailbox(&mailbox,count))
* //success
* else
* //failure
*
* }
* @endcode
* @remarks N/A
*/
EXPORT_API int email_free_mailbox(email_mailbox_t** mailbox_list, int count);
#ifdef __cplusplus
}
#endif /* __cplusplus */
/**
* @} @}
*/
#endif /* __EMAIL_API_MAILBOX_H__ */
|
