gmime/gmime-multipart.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*  GMime
   3  *  Copyright (C) 2000-2012 Jeffrey Stedfast
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public License
   7  *  as published by the Free Software Foundation; either version 2.1
   8  *  of the License, or (at your option) any later version.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this library; if not, write to the Free
  17  *  Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  18  *  02110-1301, USA.
  19  */
  20
  21
  22 #ifndef __GMIME_MULTIPART_H__
  23 #define __GMIME_MULTIPART_H__
  24
  25 #include <glib.h>
  26
  27 #include <gmime/gmime-encodings.h>
  28 #include <gmime/gmime-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GMIME_TYPE_MULTIPART            (g_mime_multipart_get_type ())
  33 #define GMIME_MULTIPART(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMIME_TYPE_MULTIPART, GMimeMultipart))
  34 #define GMIME_MULTIPART_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMIME_TYPE_MULTIPART, GMimeMultipartClass))
  35 #define GMIME_IS_MULTIPART(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GMIME_TYPE_MULTIPART))
  36 #define GMIME_IS_MULTIPART_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GMIME_TYPE_MULTIPART))
  37 #define GMIME_MULTIPART_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GMIME_TYPE_MULTIPART, GMimeMultipartClass))
  38
  39 typedef struct _GMimeMultipart GMimeMultipart;
  40 typedef struct _GMimeMultipartClass GMimeMultipartClass;
  41
  42 /**
  43  * GMimeMultipart:
  44  * @parent_object: parent #GMimeObject
  45  * @children: array of MIME sub-parts
  46  * @boundary: MIME boundary
  47  * @preface: multipart preface
  48  * @postface: multipart postface
  49  *
  50  * A base MIME multipart object.
  51  **/
  52 struct _GMimeMultipart {
  53         GMimeObject parent_object;
  54
  55         GPtrArray *children;
  56         char *boundary;
  57         char *preface;
  58         char *postface;
  59 };
  60
  61 struct _GMimeMultipartClass {
  62         GMimeObjectClass parent_class;
  63
  64         void (* clear) (GMimeMultipart *multipart);
  65         void (* add) (GMimeMultipart *multipart, GMimeObject *part);
  66         void (* insert) (GMimeMultipart *multipart, int index, GMimeObject *part);
  67         gboolean (* remove) (GMimeMultipart *multipart, GMimeObject *part);
  68         GMimeObject * (* remove_at) (GMimeMultipart *multipart, int index);
  69         GMimeObject * (* get_part) (GMimeMultipart *multipart, int index);
  70
  71         gboolean (* contains) (GMimeMultipart *multipart, GMimeObject *part);
  72         int (* index_of) (GMimeMultipart *multipart, GMimeObject *part);
  73
  74         int  (* get_count) (GMimeMultipart *multipart);
  75
  76         void (* set_boundary) (GMimeMultipart *multipart, const char *boundary);
  77         const char * (* get_boundary) (GMimeMultipart *multipart);
  78 };
  79
  80
  81 GType g_mime_multipart_get_type (void);
  82
  83 GMimeMultipart *g_mime_multipart_new (void);
  84
  85 GMimeMultipart *g_mime_multipart_new_with_subtype (const char *subtype);
  86
  87 void g_mime_multipart_set_preface (GMimeMultipart *multipart, const char *preface);
  88 const char *g_mime_multipart_get_preface (GMimeMultipart *multipart);
  89
  90 void g_mime_multipart_set_postface (GMimeMultipart *multipart, const char *postface);
  91 const char *g_mime_multipart_get_postface (GMimeMultipart *multipart);
  92
  93 void g_mime_multipart_clear (GMimeMultipart *multipart);
  94
  95 void g_mime_multipart_add (GMimeMultipart *multipart, GMimeObject *part);
  96 void g_mime_multipart_insert (GMimeMultipart *multipart, int index, GMimeObject *part);
  97 gboolean g_mime_multipart_remove (GMimeMultipart *multipart, GMimeObject *part);
  98 GMimeObject *g_mime_multipart_remove_at (GMimeMultipart *multipart, int index);
  99 GMimeObject *g_mime_multipart_replace (GMimeMultipart *multipart, int index, GMimeObject *replacement);
 100 GMimeObject *g_mime_multipart_get_part (GMimeMultipart *multipart, int index);
 101
 102 gboolean g_mime_multipart_contains (GMimeMultipart *multipart, GMimeObject *part);
 103 int g_mime_multipart_index_of (GMimeMultipart *multipart, GMimeObject *part);
 104
 105 int g_mime_multipart_get_count (GMimeMultipart *multipart);
 106
 107 void g_mime_multipart_set_boundary (GMimeMultipart *multipart, const char *boundary);
 108 const char *g_mime_multipart_get_boundary (GMimeMultipart *multipart);
 109
 110 /* convenience functions */
 111
 112 void g_mime_multipart_foreach (GMimeMultipart *multipart, GMimeObjectForeachFunc callback,
 113                                gpointer user_data);
 114
 115 GMimeObject *g_mime_multipart_get_subpart_from_content_id (GMimeMultipart *multipart,
 116                                                            const char *content_id);
 117
 118 G_END_DECLS
 119
 120 #endif /* __GMIME_MULTIPART_H__ */