EmailAppCore.h 19.8 KB
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 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 * EmailAppCore.h
 *
 * Project:
 * --------
 * MAUI
 *
 * Description:
 * ------------
 *  This file is used to declare the Email app core function.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *----------------------------------------------------------------------------
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 *----------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/

#ifndef _MMI_EMAIL_APP_CORE_H
#define _MMI_EMAIL_APP_CORE_H

#include "MMI_features.h"

//#include "SrvEmailGprot.h"
#include "App_usedetails.h"
#include "emailsrvgprot.h"
#include "MMIDataType.h"
#include "kal_general_types.h"
#include "customer_ps_inc.h"

/*
 * Define
 */

#define MMI_EMAIL_CONT_TEMP_MAX_NUMBER_PRE_LANG     (10)
#define MMI_EMAIL_CONT_TEMP_MAX_LEN                 (256)
#define MMI_EMAIL_ACCT_TEMP_MAX_NUMBER              (10)
#define MMI_EMAIL_SIG_MAX_TEXT_LEN                  (50)
#define MMI_EMAIL_SIG_MAX_NUMBER                    (10) // it should depends on max account number
#define MMI_EMAIL_SIG_MAX_IMAGE_NUMBER              (5)  // multi image signature for one account
#define MMI_EMAIL_AUTO_CHECK_MAX_NUMBER             (10)
#define MMI_EMAIL_AUTO_CHECK_DAYS_OF_WEEK			(7)
#define MMI_EMAIL_AUTO_CHECK_MAX_TIME_SEGMENT       (5)
#define MMI_EMAIL_AUTO_CHECK_SUNDAY					(0)
#define MMI_EMAIL_AUTO_CHECK_MONDAY					(1)
#define MMI_EMAIL_AUTO_CHECK_TUESDAY				(2)
#define MMI_EMAIL_AUTO_CHECK_WEDNESDAY		        (3)
#define MMI_EMAIL_AUTO_CHECK_THURSDAY				(4)
#define MMI_EMAIL_AUTO_CHECK_FRIDAY					(5)
#define MMI_EMAIL_AUTO_CHECK_SATURDAY				(6)
#define MMI_EMAIL_CONT_TEMP_INIT_FLAG_INDEX         (40)
#define MMI_EMAIL_IMAP_PUSH_ACCT_MAX_NUMBER         (10)

/*
 * Typedef
 */

typedef S32                                         MMI_EMAIL_AUTO_CHECK_ID;
typedef S32                                         MMI_EMAIL_SIG_ID;

/* tempary use */
typedef enum
{
    MMI_EMAIL_SUCCESS,
    MMI_EMAIL_FAIL,
    MMI_EMAIL_ACCOUNT_ALREADY_EXIST,
    MMI_EMAIL_ACCOUNT_NOT_EXIST,
    MMI_EMAIL_WOULDBLOCK,
    MMI_EMAIL_END_OF_ENUM
} mmi_email_app_core_result_enum;
/* tempary use */


typedef void (*async_callback)(S32, void*);
typedef void (*auto_check_nofity_fn)(EMAIL_ACCT_ID);


typedef enum
{
    //MMI_EMAIL_CONT_TEMP_TYPE_ALL_KIND,
    MMI_EMAIL_CONT_TEMP_TYPE_PRE_DEFINED,
    MMI_EMAIL_CONT_TEMP_TYPE_PRE_DEFINED_ENG = MMI_EMAIL_CONT_TEMP_TYPE_PRE_DEFINED,
    MMI_EMAIL_CONT_TEMP_TYPE_PRE_DEFINED_SC,
    MMI_EMAIL_CONT_TEMP_TYPE_PRE_DEFINED_TC,
    MMI_EMAIL_CONT_TEMP_TYPE_USER_DEFINED,
    MMI_EMAIL_CONT_TEMP_TYPE_END_OF_ENUM
} mmi_email_cont_temp_type_enum;

typedef enum
{
    MMI_EMAIL_EMAIL_DATA_ALL_KIND,
    MMI_EMAIL_EMAIL_DATA_URL,
    MMI_EMAIL_EMAIL_DATA_ADDR,
    MMI_EMAIL_EMAIL_DATA_PHONE_NUMBER,
    MMI_EMAIL_EMAIL_DATA_END_OF_ENUM
} mmi_email_emaildata_aotufind_type_enum;

typedef enum
{
    MMI_EMAIL_SIG_INVALID = 0,
    MMI_EMAIL_SIG_INIT,
    MMI_EMAIL_SIG_OFF = MMI_EMAIL_SIG_INIT,
    MMI_EMAIL_SIG_ON,
    MMI_EMAIL_SIG_END_OF_ENUM
} mmi_email_sig_status_enmu;

typedef enum
{
    MMI_EMAIL_AUTO_CHECK_DISABLE,
    MMI_EMAIL_AUTO_CHECK_ENABLE,
    MMI_EMAIL_AUTO_CHECK_END_OF_ENUM
} mmi_email_auto_check_status_enum;

typedef struct
{
    WCHAR server_name[SRV_EMAIL_MAX_SERVER_NAME_LEN + 1];   /* The server name (WCHAR string) */
    U16 port_num;                       /* The part number, 0 means using the default value */
    U16 sec_port_num;                   /* security port num */
    srv_email_sec_mode_enum sec_mode;   /* The security mode */
} mmi_email_acct_server_struct;

/* signature */
typedef struct
{
    MMI_BOOL validity;
    U16 user_num;                                           /* This signature is used by how many account */
    WCHAR text[MMI_EMAIL_SIG_MAX_TEXT_LEN + 1];             /* Text of signature */
    U16 image_num;                                          /* Number of image of this signature */
    WCHAR image_name[MMI_EMAIL_SIG_MAX_IMAGE_NUMBER][EMAIL_ATTCH_FILE_NAME_LEN + 1];
                                                            /* use macro of file manager */
                                                            /* 
                                                               MMI_EMAIL_SIG_MAX_TEXT_LEN tempary use
                                                             */
} mmi_email_sig_struct;

typedef struct
{
    MMI_BOOL status;                            /* Status of this signature */
    MMI_EMAIL_SIG_ID sig_id;                    /* Signature id (index) of this account */
    EMAIL_ACCT_ID acct_id;                      /* Account id */
} mmi_email_acct_sig_map;

/* auto check */
typedef struct
{
    MMI_BOOL status;                            /* Status of this auto check */
    MMI_EMAIL_AUTO_CHECK_ID auto_check_id;      /* Signature id (index) of this account */
    EMAIL_ACCT_ID acct_id;                      /* Account id */
} mmi_email_acct_auto_check_map;

typedef struct
{
    U32 start_time;
    U32 stop_time;
    U32 interval;
} mmi_email_auto_check_time_segment;

typedef struct
{
    MMI_BOOL enable;
    U16 roaming_num;
    mmi_email_auto_check_time_segment roaming[MMI_EMAIL_AUTO_CHECK_MAX_TIME_SEGMENT];
    U16 normal_num;
    mmi_email_auto_check_time_segment normal[MMI_EMAIL_AUTO_CHECK_MAX_TIME_SEGMENT];
} mmi_email_auto_check_day_struct;

typedef struct
{
	U16 user_num;
	MMI_BOOL validity;
	mmi_email_auto_check_day_struct days[MMI_EMAIL_AUTO_CHECK_DAYS_OF_WEEK];
} mmi_email_auto_check_struct;

/* autofind */
typedef struct
{
    mmi_email_emaildata_aotufind_type_enum type;
    WCHAR *start_index;
    S32 len;
} mmi_email_emaildata_autofind_struct;

/* account template */
typedef struct
{
    WCHAR acct_name[SRV_EMAIL_MAX_ACCT_NAME_LEN + 1];
    WCHAR addr[SRV_EMAIL_MAX_ADDR_LEN + 1];
    srv_email_prot_type_enum protocol;
    mmi_email_acct_server_struct incoming_server;
    mmi_email_acct_server_struct outgoing_server;
    MMI_BOOL username_format;
    MMI_BOOL outgoing_auth;
} mmi_email_acct_temp_struct;

/*
 * Extern Global Function
 */

void mmi_email_app_core_init(void);

extern S32 mmi_email_app_core_get_fs_error_detail(void);

/*
 * Content template api
 */
mmi_email_app_core_result_enum mmi_email_cont_temp_get_valid_number(
                                        mmi_email_cont_temp_type_enum type,
                                        U16 *number);
mmi_email_app_core_result_enum mmi_email_cont_temp_read(
                                        mmi_email_cont_temp_type_enum type,
                                        U16 index,
                                        WCHAR *text,
                                        U16 len);
mmi_email_app_core_result_enum mmi_email_cont_temp_edit(
                                        mmi_email_cont_temp_type_enum type,
                                        U16 index,
                                        WCHAR *text,
                                        U16 len);
mmi_email_app_core_result_enum mmi_email_cont_temp_clear(
                                        mmi_email_cont_temp_type_enum type,
                                        U16 index);

/*
 * Email data api
 */
applib_address_node_struct* mmi_email_emaildata_autofind(
                                    CHAR *text,
                                    MMI_BOOL text_type,
                                    U32 len,
                                    applib_addr_type_enum type,
                                    applib_mem_alloc_fn mem_alloc,
                                    applib_mem_free_fn mem_free,
                                    applib_check_stop_fn check_stop_fn,
                                    applib_charset_enum input_data_type,
                                    MMI_BOOL *is_stopped);
mmi_email_app_core_result_enum mmi_email_emaildata_disp_name_to_addr(
                                        WCHAR *disp_name,
                                        U16 len_1,
                                        WCHAR *addr_1,
                                        U16 len_2,
                                        WCHAR *addr_2);
mmi_email_app_core_result_enum mmi_email_emaildata_group_to_addr(
                                        WCHAR *group,
                                        S32 *addr_num,
                                        U16 addr_len,
                                        WCHAR **addr_list_1,
                                        WCHAR **addr_list_2);


/*
 * Account template api
 */
mmi_email_app_core_result_enum mmi_email_acct_temp_get_num(S32 *num);
mmi_email_app_core_result_enum mmi_email_acct_temp_check_addr(
                                        WCHAR *addr,
                                        S32 *index);
mmi_email_app_core_result_enum mmi_email_acct_temp_get_acct(
                                        S32 index,
                                        mmi_email_acct_temp_struct *acct_temp);

mmi_email_app_core_result_enum mmi_email_acct_temp_get_group_num(S32 *num);
mmi_email_app_core_result_enum mmi_email_acct_temp_get_group_name(S32 index, WCHAR *group_name, S32 name_len);
mmi_email_app_core_result_enum mmi_email_acct_temp_get_group_data_num(WCHAR *group_name, S32 *num);
mmi_email_app_core_result_enum mmi_email_acct_temp_get_group_data_all(
                                WCHAR *group_name,
                                S32 *num,
                                mmi_email_acct_temp_struct *acct_temp);
mmi_email_app_core_result_enum mmi_email_acct_temp_get_group_data_by_index(
                                WCHAR *group_name,
                                S32 index,
                                mmi_email_acct_temp_struct *acct_temp);


/*
 * Signature api
 */
mmi_email_app_core_result_enum mmi_email_sig_list_acct_id(
                                        EMAIL_ACCT_ID *acct_id_list,
                                        U16 *array_len);
mmi_email_app_core_result_enum mmi_email_sig_list_id(
                                        MMI_EMAIL_SIG_ID *sig_id_list,
                                        U16 *array_len);
mmi_email_app_core_result_enum mmi_email_sig_use_exist(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_EMAIL_SIG_ID sig_id);
mmi_email_app_core_result_enum mmi_email_sig_create(EMAIL_ACCT_ID acct_id);
mmi_email_app_core_result_enum mmi_email_sig_delete_acct(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_BOOL destroy_sig);
mmi_email_app_core_result_enum mmi_email_sig_get_status(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_BOOL *status);
mmi_email_app_core_result_enum mmi_email_sig_set_status(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_BOOL status);
mmi_email_app_core_result_enum mmi_email_sig_get_signature(
                                        EMAIL_ACCT_ID acct_id,
                                        mmi_email_sig_struct *signature);
mmi_email_app_core_result_enum mmi_email_sig_get_text(
                                        EMAIL_ACCT_ID acct_id,
                                        WCHAR *text,
                                        U16 len);
mmi_email_app_core_result_enum mmi_email_sig_set_text(
                                        EMAIL_ACCT_ID acct_id,
                                        WCHAR *text,
                                        U16 len);
mmi_email_app_core_result_enum mmi_email_sig_clear_text(EMAIL_ACCT_ID acct_id);
mmi_email_app_core_result_enum mmi_email_sig_get_image_path(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 index,
                                        WCHAR *image_path,
                                        U16 len);
S32 mmi_email_sig_add_image(
                                        EMAIL_ACCT_ID acct_id,
                                        WCHAR *image_path,
                                        async_callback callback,
                                        void* user_data);
S32 mmi_email_sig_edit_image(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 index,
                                        WCHAR *image_path,
                                        async_callback callback,
                                        void* user_data);
mmi_email_app_core_result_enum mmi_email_sig_delete_image(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 index);
mmi_email_app_core_result_enum mmi_email_sig_delete_all_image(EMAIL_ACCT_ID acct_id);


/*
 * Auto check api
 */
mmi_email_app_core_result_enum mmi_email_auto_check_list_acct_id(
                                        EMAIL_ACCT_ID *acct_id_list,
                                        U16 *array_len);
mmi_email_app_core_result_enum mmi_email_auto_check_create(EMAIL_ACCT_ID acct_id);
mmi_email_app_core_result_enum mmi_email_auto_check_list_id(
                                        MMI_EMAIL_SIG_ID *auto_check_id_list,
                                        U16 *array_len);
mmi_email_app_core_result_enum mmi_email_auto_check_use_exist(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_EMAIL_AUTO_CHECK_ID auto_check_id);
mmi_email_app_core_result_enum mmi_email_auto_check_delete_acct(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_BOOL destroy_auto_check);
mmi_email_app_core_result_enum mmi_email_auto_check_start(EMAIL_ACCT_ID acct_id);
mmi_email_app_core_result_enum mmi_email_auto_check_stop(EMAIL_ACCT_ID acct_id);
mmi_email_app_core_result_enum mmi_email_auto_check_stop_all(void);
extern void mmi_email_auto_check_stop_service(void);
extern mmi_email_app_core_result_enum mmi_email_auto_check_start_service(auto_check_nofity_fn nofity_fn);
mmi_email_app_core_result_enum mmi_email_auto_check_get_status(
                                        EMAIL_ACCT_ID acct_id,
                                        MMI_BOOL *status);
//void mmi_email_auto_check_set_status(
//                EMAIL_ACCT_ID acct_id,
//                MMI_BOOL status);
mmi_email_app_core_result_enum mmi_email_auto_check_reset_day(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day);
mmi_email_app_core_result_enum mmi_email_auto_check_reset_all_day(EMAIL_ACCT_ID acct_id);
mmi_email_app_core_result_enum mmi_email_auto_check_get_day_enable(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        MMI_BOOL *enable);
mmi_email_app_core_result_enum mmi_email_auto_check_set_day_enable(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        MMI_BOOL enable);
mmi_email_app_core_result_enum mmi_email_auto_check_get_segment_num(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        U16 *num);
/************************ segment list operation ****************************/
mmi_email_app_core_result_enum mmi_email_auto_check_get_segment(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        U16 index,
                                        mmi_email_auto_check_time_segment *segment);
mmi_email_app_core_result_enum mmi_email_auto_check_add_segment(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        mmi_email_auto_check_time_segment *segment);
mmi_email_app_core_result_enum mmi_email_auto_check_edit_segment(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        U16 index,
                                        mmi_email_auto_check_time_segment *segment);
mmi_email_app_core_result_enum mmi_email_auto_check_delete_segment(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day,
                                        U16 index);
mmi_email_app_core_result_enum mmi_email_auto_check_delete_all_segment(
                                        EMAIL_ACCT_ID acct_id,
                                        U16 day);

#ifdef __MMI_EMAIL_IMAP_PUSH__
/************************ imap push mail ************************************/
extern mmi_email_app_core_result_enum mmi_email_imap_push_set_status(MMI_BOOL status);
extern mmi_email_app_core_result_enum mmi_email_imap_push_get_status(MMI_BOOL *status);
extern mmi_email_app_core_result_enum mmi_email_imap_push_acct_add(EMAIL_ACCT_ID acct_id);
extern mmi_email_app_core_result_enum mmi_email_imap_push_acct_remove(EMAIL_ACCT_ID acct_id);
extern mmi_email_app_core_result_enum mmi_email_imap_push_acct_get(EMAIL_ACCT_ID *acct_array, U32 *count);
#endif /* __MMI_EMAIL_IMAP_PUSH__ */


#endif /* _MMI_EMAIL_APP_CORE_H */