git.maemo.org Git - modest/blob - src/modest-tny-msg.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_H__
  31 #define __MODEST_TNY_MSG_H__
  32
  33 /**
  34  * modest_tny_msg_find_body_part:
  35  * @self: a message
  36  * @want_html: prefer HTML-part when there are multiple body parts?
  37  *
  38  * search a message for the body part. if @want_html is true, try HTML mail
  39  * first.
  40  *
  41  * Returns: the TnyMsgMimePart for the found part, or NULL if no matching part is found
  42  */
  43 TnyMimePart *modest_tny_msg_find_body_part (TnyMsg * self, gboolean want_html);
  44
  45
  46 /**
  47  * modest_tny_msg_get_nth_part:
  48  * @self: a message
  49  * @index: number (1-based) of the part to retrieve
  50  *
  51  * search for the nth (mime) part in the message
  52  *
  53  * Returns: the TnyMsgMimePart for the found part, or NULL if no
  54  * matching part is foundi; must be unref'd
  55  */
  56 TnyMimePart* modest_tny_msg_find_nth_part (TnyMsg *msg, gint index);
  57
  58
  59 /**
  60  * modest_tny_msg_find_body:
  61  * @self:
  62  * @want_html:
  63  *
  64  * gets the body of a message as text, if @want_html is true, try HTML mail
  65  * first.
  66  *
  67  * Returns: the body of the message as text, or NULL if it is not found
  68  * the text should be freed with
  69  **/
  70 gchar* modest_tny_msg_get_body (TnyMsg *self, gboolean want_html);
  71
  72 #endif /* __MODEST_TNY_MSG_H__ */