git.maemo.org Git - modest/blob - src/modest-tny-mime-part.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_MIME_PART_H__
  31 #define __MODEST_TNY_MIME_PART_H__
  32
  33 #include <tny-mime-part.h>
  34
  35 /**
  36  * modest_tny_mime_part_get_header_value:
  37  * @self: some #TnyMimePart
  38  * @header: the header to get
  39  *
  40  * gets the mail header for a #TnyMimePart as a newly allocated string,
  41  * or NULL if it cannot be found
  42  *
  43  * Returns: the header
  44  **/
  45 gchar* modest_tny_mime_part_get_header_value (TnyMimePart *part, const gchar *header);
  46
  47
  48 /**
  49  * modest_tny_mime_part_is_attachment_for_modest
  50  * @self: some #TnyMimePart
  51  *
  52  * determines whether some MIME part is an attachment, from Modest's PoV.
  53  *
  54  * Returns: TRUE if it's an attachment, FALSE otherwise.
  55  **/
  56
  57 gboolean modest_tny_mime_part_is_attachment_for_modest (TnyMimePart *part);
  58
  59 /**
  60  * modest_tny_mime_part_is_msg:
  61  * @part: a #TnyMimePart
  62  *
  63  * determines if this is a message (it's a TnyMsg and it's not a
  64  * file attached as the top mime part of the TnyMsg).
  65  *
  66  * Returns: %TRUE if it's a real message, %FALSE otherwise
  67  */
  68 gboolean modest_tny_mime_part_is_msg (TnyMimePart *part);
  69
  70 /**
  71  * modest_tny_mime_part_to_string:
  72  * @part: a #TnyMimePart
  73  * @indent: indent level (should be 0)
  74  *
  75  * Shows in stdout a text representation of the mime structure of
  76  * the message. This is intended for debugging.
  77  */
  78 void modest_tny_mime_part_to_string (TnyMimePart *part, gint indent);
  79
  80 /**
  81  * modest_tny_mime_part_get_content_type:
  82  * @part: a #TnyMimePart
  83  *
  84  * obtains the content type in headers
  85  */
  86 gchar *modest_tny_mime_part_get_headers_content_type (TnyMimePart *part);
  87
  88 /**
  89  * modest_tny_mime_part_get_content_type:
  90  * @part: a #TnyMimePart
  91  *
  92  * obtains the content type of a mime part, taking into account that,
  93  * for messages with type message/rfc822 it has to get it from
  94  * the headers
  95  */
  96 gchar *modest_tny_mime_part_get_content_type (TnyMimePart *part);
  97
  98 #endif /*__MODEST_TNY_MIME_PART_H__*/