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

   1 /* Copyright (c) 2006, 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_ACTIONS_H__
  31 #define __MODEST_TNY_MSG_ACTIONS_H__
  32
  33 /* public */
  34
  35 /**
  36  * modest_tny_msg_actions_quote:
  37  * @self: the message to quote
  38  * @from: the original sender of the message
  39  * @sent_date: the date the original message was sent
  40  * @limit: characters per line limit for the quoted message
  41  * @to_quote: a string to quote instead of the message body
  42  *
  43  * reply-quotes a message or @to_quote if it's not NULL.
  44
  45  * Note: @from and @sent_date may be eliminated from the API in future versions
  46  *
  47  * Returns: a newly allocated string containing the quoted message
  48  */
  49 gchar *modest_tny_msg_actions_quote (const TnyMsgIface * self,
  50                                      const gchar * from,
  51                                      time_t sent_date,
  52                                      gint limit,
  53                                      const gchar *to_quote);
  54
  55 /**
  56  * modest_tny_msg_actions_find_body_part:
  57  * @self: a message
  58  * @want_html: prefer HTML-part when there are multiple body parts?
  59  *
  60  * search a message for the body part. if @want_html is true, try HTML mail
  61  * first.
  62  *
  63  * Returns: the TnyMsgMimePartIface for the found part, or NULL if no matching part is found
  64  */
  65 TnyMsgMimePartIface *modest_tny_msg_actions_find_body_part (const TnyMsgIface * self,
  66                                                             gboolean want_html);
  67
  68
  69 /**
  70  * modest_tny_msg_actions_get_nth_part:
  71  * @self: a message
  72  * @index: number (1-based) of the part to retrieve
  73  *
  74  * search for the nth (mime) part in the message
  75  *
  76  * Returns: the TnyMsgMimePartIface for the found part, or NULL if no matching part is found
  77  */
  78 TnyMsgMimePartIface * modest_tny_msg_actions_find_nth_part (const TnyMsgIface *msg,
  79                                                            gint index);
  80
  81
  82 #endif /* __MODEST_TNY_MSG_ACTIONS_H__ */