git.maemo.org Git - modest/blob - src/modest-tny-msg.h

   1 /* Copyright (c) 2006, 2007, 2008 Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_TNY_MSG_H__
  31 #define __MODEST_TNY_MSG_H__
  32
  33 /**
  34  * ModestTnyMsgForwardType:
  35  *
  36  * How the original message will be forwarded to the recipient
  37  */
  38 typedef enum _ModestTnyMsgForwardType {
  39         MODEST_TNY_MSG_FORWARD_TYPE_INLINE = 1,
  40         MODEST_TNY_MSG_FORWARD_TYPE_ATTACHMENT
  41 } ModestTnyMsgForwardType;
  42
  43 /**
  44  * ModestTnyMsgReplyType:
  45  *
  46  * How the original message will be forwarded to the recipient
  47  */
  48 typedef enum _ModestTnyMsgReplyType {
  49         MODEST_TNY_MSG_REPLY_TYPE_CITE = 1,
  50         MODEST_TNY_MSG_REPLY_TYPE_QUOTE
  51 } ModestTnyMsgReplyType;
  52
  53 /**
  54  * ModestTnyMsgReplyMode:
  55  *
  56  * Who will be the recipients of the replied message
  57  */
  58 typedef enum _ModestTnyMsgReplyMode {
  59         MODEST_TNY_MSG_REPLY_MODE_SENDER,
  60         MODEST_TNY_MSG_REPLY_MODE_LIST,
  61         MODEST_TNY_MSG_REPLY_MODE_ALL
  62 } ModestTnyMsgReplyMode;
  63
  64 /**
  65  * modest_tny_msg_new:
  66  * @mailto: recipient for the message
  67  * @mailfrom: sender of this message
  68  * @cc: Cc: address for the message
  69  * @bcc: Bcc: address for the message
  70  * @subject: subject for the messdage
  71  * @body: body for the message
  72  * @attachments: a list of attachments (local URIs)
  73  * @error: a pointer for errors in message creation
  74  *
  75  * create a new TnyMsg with the given parameters
  76  *
  77  * Returns: a new TnyMsg (free with g_object_unref)
  78  */
  79 TnyMsg* modest_tny_msg_new (const gchar* mailto, const gchar* mailfrom, const gchar *cc,
  80                             const gchar *bcc, const gchar* subject, const gchar *body,
  81                             GList *attachments, GError **err);
  82
  83 /**
  84  * modest_tny_msg_new_html_plain:
  85  * @mailto: recipient for the message
  86  * @mailfrom: sender of this message
  87  * @cc: Cc: address for the message
  88  * @bcc: Bcc: address for the message
  89  * @subject: subject for the message
  90  * @html_body: body for the message in HTML
  91  * @plain_body: body for the message in plain text
  92  * @attachments: a list of attachments (mime parts)
  93  * @attachments: a list of images (mime parts)
  94  * @error: a pointer for errors in message creation
  95  *
  96  * create a new TnyMsg with the given parameters
  97  *
  98  * Returns: a new TnyMsg (free with g_object_unref)
  99  */
 100 TnyMsg* modest_tny_msg_new_html_plain (const gchar* mailto, const gchar* mailfrom, const gchar *cc,
 101                                        const gchar *bcc, const gchar* subject,
 102                                        const gchar *html_body, const gchar *plain_body,
 103                                        GList *attachments, GList *images, GError **err);
 104
 105 /**
 106  * modest_tny_msg_find_body_part:
 107  * @self: a message
 108  * @want_html: prefer HTML-part when there are multiple body parts?
 109  *
 110  * search a message for the body part. if @want_html is true, try HTML mail
 111  * first.
 112  *
 113  * Returns: the TnyMsgMimePart for the found part, or NULL if no matching part is found
 114  */
 115 TnyMimePart*  modest_tny_msg_find_body_part  (TnyMsg * self, gboolean want_html);
 116
 117
 118 /**
 119  * modest_tny_msg_find_body:
 120  * @self: some #TnyMsg
 121  * @want_html:
 122  * @is_html: if the original body was html or plain text
 123  *
 124  * gets the body of a message as text, if @want_html is true, try HTML mail
 125  * first.
 126  *
 127  * Returns: the body of the message as text, or NULL if it is not found
 128  * the text should be freed with
 129  **/
 130 gchar*        modest_tny_msg_get_body        (TnyMsg *self, gboolean want_html, gboolean *is_html);
 131
 132
 133
 134
 135 /**
 136  * modest_tny_msg_create_forward_msg:
 137  * @msg: a valid #TnyMsg instance
 138  * @from: the sender of the forwarded mail
 139  * @signature: signature to attach to the reply
 140  * @forward_type: the type of formatting used to create the forwarded message
 141  *
 142  * Creates a forwarded message from an existing one
 143  *
 144  * Returns: a new #TnyMsg, or NULL in case of error
 145  **/
 146 TnyMsg*       modest_tny_msg_create_forward_msg   (TnyMsg *msg,
 147                                                    const gchar *from,
 148                                                    const gchar *signature,
 149                                                    ModestTnyMsgForwardType forward_type);
 150
 151 /**
 152  * modest_tny_msg_create_reply_msg:
 153  * @msg: a valid #TnyMsg instance, or %NULL
 154  * @header: a valid #TnyHeader instance, or %NULL
 155  * @from: the sender of the forwarded mail
 156  * @signature: signature to add to the reply message
 157  * @reply_type: the type of formatting used to create the reply message
 158  * @reply_mode: the mode of reply: to the sender only, to a mail list or to all
 159  *
 160  * Creates a new message to reply to an existing one
 161  *
 162  * Returns: Returns: a new #TnyMsg, or NULL in case of error
 163  **/
 164 TnyMsg*       modest_tny_msg_create_reply_msg     (TnyMsg *msg,
 165                                                    TnyHeader *header,
 166                                                    const gchar *from,
 167                                                    const gchar *signature,
 168                                                    ModestTnyMsgReplyType reply_type,
 169                                                    ModestTnyMsgReplyMode reply_mode);
 170
 171
 172 /**
 173  * modest_tny_msg_get_parent_unique_id
 174  * @msg: a valid #TnyMsg instance, or %NULL
 175  *
 176  * gets the unique ID of the 'parent' (the original msg replied to or forward)
 177  *
 178  * Returns: Returns: a the parent uid, or NULL if there is none.
 179  **/
 180 const gchar*  modest_tny_msg_get_parent_uid (TnyMsg *msg);
 181
 182
 183 /**
 184  * modest_tny_msg_estimate_size:
 185  * @plain_body: a string
 186  * @html_body: a string
 187  * @parts_number: a gint (number of additional parts)
 188  * @parts_size: a guint64 (sum of size of the additional parts)
 189  *
 190  * Estimates the size of the resulting message obtained from the size of the body
 191  * parts, and adding the estimation of size headers.
 192  */
 193 guint64
 194 modest_tny_msg_estimate_size (const gchar *plain_body, const gchar *html_body,
 195                               guint64 parts_count,
 196                               guint64 parts_size);
 197
 198 #endif /* __MODEST_TNY_MSG_H__ */