doc/email_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_EMAIL_DOC_H__
  19 #define __TIZEN_EMAIL_DOC_H__
  20
  21 /**
  22  * @ingroup CAPI_MESSAGING_FRAMEWORK
  23  * @defgroup CAPI_MESSAGING_EMAIL_MODULE Email (Deprecated)
  24  * @addtogroup CAPI_MESSAGING_EMAIL_MODULE
  25  * @brief The Email API provides functions to create, set properties and send email.
  26  * @section CAPI_MESSAGING_EMAIL_MODULE_HEADER Required Header
  27  *   \#include <email.h>
  28  *
  29  * @section CAPI_MESSAGING_EMAIL_MODULE_OVERVIEW Overview
  30  *
  31  * The @ref CAPI_MESSAGING_EMAIL_MODULE API provides functions that prepare and send email messages.
  32  * This API allows email message creation, setting message properties
  33  * and sending as well setting up to be notified when the email message has been sent.
  34  *
  35  * Email, short for electronic mail, is a method of exchanging digital messages.
  36  * This API allows you to send email using SMTP.
  37  * Simple Mail Transfer Protocol (SMTP) used for sending email via Internet is described in RFC5321/5322 standards.
  38  *
  39  * The Email API consists of functions that:
  40  * - Set the subject, body and recipients of an email message
  41  * - Set the file path for attaching files to an email message
  42  * - Send an email message
  43  * - Register/unregister a callback function to be called when the sending process is complete,
  44  *     whether it is sent successfully or not
  45  *
  46  * @section CAPI_MESSAGING_EMAIL_MODULE_FEATURE Related Features
  47  * This API is related with the following features:\n
  48  * - %http://tizen.org/feature/email\n
  49  *
  50  * It is recommended to design feature related codes in your application for reliability.\n
  51  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  52  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  53  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  54  *
  55  * Email sending is asynchronous and the application should not wait for the result.
  56  * Not only may the process be slow (connections to be established and so on),
  57  * but even if the mail server is not available a message send may not be a failure, if there is a spooling mechanism.
  58  * Instead, the callback function is used to receive status. In addition, note that once email_send_message() is called,
  59  * the message contents are out of the application's hands.
  60  * Even if the message appears not to have finished sending, it can no longer be modified.
  61  *
  62  * @subsection CAPI_MESSAGING_EMAIL_CALLBACK_OPERATIONS Callback(Event) Operations
  63  * <div><table class="doxtable" >
  64  *     <tr>
  65  *        <th><b>REGISTER</b></th>
  66  *        <th><b>UNREGISTER</b></th>
  67  *        <th><b>CALLBACK</b></th>
  68  *        <th><b>DESCRIPTION</b></th>
  69  *     </tr>
  70  *     <tr>
  71  *        <td>email_set_message_sent_cb()</td>
  72  *        <td>email_unset_message_sent_cb()</td>
  73  *        <td>email_message_sent_cb()</td>
  74  *        <td>Registering/unregistering a callback function to check whether an email message is sent successfully or not </td>
  75  *     </tr>
  76  *</table></div>
  77  * <BR>
  78  */
  79
  80
  81 #endif /* __TIZEN_EMAIL_DOC_H__ */