Deprecating email module

[platform/core/api/email.git] / include / email.h

diff --git a/include/email.h b/include/email.h
index ceb7fce..f082702 100755 (executable)
--- a/include/email.h
+++ b/include/email.h
@@ -43,6 +43,7 @@ extern "C"
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Creates an email message handle for sending an email message.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @privlevel public
@@ -59,10 +60,11 @@ extern "C"
  * @pre At least one email account should be set up on the device.
  * @see email_destroy_message()
  */
-int email_create_message(email_h *email);
+int email_create_message(email_h *email) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Destroys the email message handle and releases all its resources.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @param[in] email The handle to the email message
@@ -74,10 +76,11 @@ int email_create_message(email_h *email);
  * @retval #EMAILS_ERROR_NOT_SUPPORTED Not supported
  * @see email_create_message()
  */
-int email_destroy_message(email_h email);
+int email_destroy_message(email_h email) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Sets a subject of the email message.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @privlevel public
@@ -94,10 +97,11 @@ int email_destroy_message(email_h email);
  * @pre An email message handle is created using email_create_message().
  * @see email_create_message()
  */
-int email_set_subject(email_h email, const char *subject);
+int email_set_subject(email_h email, const char *subject) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Populates a body of the email message.
  * @details Email message body means the text data to be delivered.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@@ -115,10 +119,11 @@ int email_set_subject(email_h email, const char *subject);
  * @pre An email message handle is created using email_create_message().
  * @see email_create_message()
  */
-int email_set_body(email_h email, const char *body);
+int email_set_body(email_h email, const char *body) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Adds a recipient to the email message.
  * @details The email API supports sending an email message to multiple recipients.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@@ -137,10 +142,11 @@ int email_set_body(email_h email, const char *body);
  * @see email_create_message()
  * @see email_remove_all_recipients()
  */
-int email_add_recipient(email_h email, email_recipient_type_e type, const char *address);
+int email_add_recipient(email_h email, email_recipient_type_e type, const char *address) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Removes all recipients for the email message.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @param[in] email The handle to the email message
@@ -152,10 +158,11 @@ int email_add_recipient(email_h email, email_recipient_type_e type, const char *
  * @pre An email message handle is created using email_create_message().
  * @see email_add_recipient()
  */
-int email_remove_all_recipients(email_h email);
+int email_remove_all_recipients(email_h email) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Adds a file as an attachment to the email message.
  * @details It should be used to add a file to the attachment list
  *          of the email message.
@@ -175,10 +182,11 @@ int email_remove_all_recipients(email_h email);
  * @pre An email message handle is created using email_create_message().
  * @see email_remove_all_attachments()
  */
-int email_add_attach(email_h email, const char *filepath);
+int email_add_attach(email_h email, const char *filepath) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Clears all attachments of the email message.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @param[in] email The handle to the email message
@@ -191,10 +199,11 @@ int email_add_attach(email_h email, const char *filepath);
  * @see email_create_message()
  * @see email_add_attach()
  */
-int email_remove_all_attachments(email_h email);
+int email_remove_all_attachments(email_h email) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Saves the email message at outbox.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @privlevel public
@@ -212,10 +221,11 @@ int email_remove_all_attachments(email_h email);
  * @see email_add_recipient()
  * @see email_set_body()
  */
-int email_save_message(email_h email);
+int email_save_message(email_h email) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Sends the email message.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @remarks In order to check whether sending a message succeeds,
@@ -233,10 +243,11 @@ int email_save_message(email_h email);
  * @see email_save_message()
  * @see email_set_message_sent_cb()
  */
-int email_send_message(email_h email, bool save_to_sentbox);
+int email_send_message(email_h email, bool save_to_sentbox) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called when the process of sending an email finishes.
  * @details You can check whether sending an email succeeds using this function.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@@ -253,6 +264,7 @@ typedef void (*email_message_sent_cb)(email_h email, email_sending_e result, voi
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Registers a callback function to be invoked when an email message is sent.
  * @details You will be notified when sending a message finishes and check whether it succeeds using this function.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
@@ -269,10 +281,11 @@ typedef void (*email_message_sent_cb)(email_h email, email_sending_e result, voi
  * @see email_unset_message_sent_cb()
  * @see email_send_message()
  */
-int email_set_message_sent_cb(email_h email, email_message_sent_cb callback, void *user_data);
+int email_set_message_sent_cb(email_h email, email_message_sent_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Unregisters the callback function.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif
  * @param[in] msg The handle to the email message
@@ -285,7 +298,7 @@ int email_set_message_sent_cb(email_h email, email_message_sent_cb callback, voi
  * @see email_set_message_sent_cb()
  * @see email_send_message()
  */
-int email_unset_message_sent_cb(email_h msg);
+int email_unset_message_sent_cb(email_h msg) TIZEN_DEPRECATED_API;
 
 
 #ifdef __cplusplus