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