email-core/include/email-core-imap-idle.h

   1 /*
   2 *  email-service
   3 *
   4 * Copyright (c) 2012 - 2013 Samsung Electronics Co., Ltd. All rights reserved.
   5 *
   6 * Contact: Kyuho Jo <kyuho.jo@samsung.com>, Sunghyun Kwon <sh0701.kwon@samsung.com>
   7 *
   8 * Licensed under the Apache License, Version 2.0 (the "License");
   9 * you may not use this file except in compliance with the License.
  10 * You may obtain a copy of the License at
  11 *
  12 * http://www.apache.org/licenses/LICENSE-2.0
  13 *
  14 * Unless required by applicable law or agreed to in writing, software
  15 * distributed under the License is distributed on an "AS IS" BASIS,
  16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 * See the License for the specific language governing permissions and
  18 * limitations under the License.
  19 *
  20 */
  21
  22
  23 /**
  24  *
  25  * This file contains functinality related to IMAP IDLE.
  26  * @file                email-core-imap-idle.h
  27  * @author
  28  * @version     0.1
  29  * @brief               This file contains functionality to provide IMAP IDLE support in email-service.
  30  */
  31
  32 #include "email-internal-types.h"
  33
  34 /**
  35
  36
  37  * @fn emcore_create_imap_idle_thread(int *err_code)
  38  * @brief       Creates a thread that listens for IMAP IDLE Notifications.
  39  *
  40  * @param[out] err_code Specifies the error code returned.
  41  * @remarks N/A
  42  * @return This function returns true on success or false on failure.
  43  */
  44
  45 INTERNAL_FUNC int emcore_create_imap_idle_thread(int accountID, int *err_code);
  46
  47 /**
  48
  49
  50  * @fn emcore_kill_imap_idle_thread(int *err_code)
  51  * @brief       Kills IMAP IDLE thread
  52  *
  53  * @param[out] err_code Specifies the error code returned.
  54  * @remarks N/A
  55  * @return This function returns true on success or false on failure.
  56  */
  57 INTERNAL_FUNC int emcore_kill_imap_idle_thread(int *err_code);