* src/procmime.h
[claws.git] / src / procmime.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2001 Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program 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
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __PROCMIME_H__
21 #define __PROCMIME_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <stdio.h>
29
30 typedef struct _MimeType        MimeType;
31 typedef struct _MimeInfo        MimeInfo;
32
33 #include "procmsg.h"
34
35 typedef enum
36 {
37         ENC_7BIT,
38         ENC_8BIT,
39         ENC_BINARY,
40         ENC_QUOTED_PRINTABLE,
41         ENC_BASE64,
42         ENC_X_UUENCODE,
43         ENC_UNKNOWN
44 } EncodingType;
45
46 typedef enum
47 {
48         MIME_TEXT,
49         MIME_TEXT_HTML,
50         MIME_MESSAGE_RFC822,
51         MIME_APPLICATION,
52         MIME_APPLICATION_OCTET_STREAM,
53         MIME_MULTIPART,
54         MIME_IMAGE,
55         MIME_AUDIO,
56         MIME_TEXT_ENRICHED,
57         MIME_UNKNOWN
58 } ContentType;
59
60 struct _MimeType
61 {
62         gchar *type;
63         gchar *sub_type;
64
65         gchar *extension;
66 };
67
68 /*
69  * An example of MimeInfo structure:
70  *
71  * multipart/mixed            root  <-+ parent
72  *                                    |
73  *   multipart/alternative      children <-+ parent
74  *                                         |
75  *     text/plain                 children  --+
76  *                                            |
77  *     text/html                  next      <-+
78  *
79  *   message/rfc822             next  <-+ main
80  *                                      |
81  *                                sub (capsulated message)
82  *
83  *   image/jpeg                 next
84  */
85
86 struct _MimeInfo
87 {
88         gchar *encoding;
89
90         EncodingType encoding_type;
91         ContentType  mime_type;
92
93         gchar *content_type;
94         gchar *charset;
95         gchar *name;
96         gchar *boundary;
97
98         gchar *content_disposition;
99         gchar *filename;
100
101         glong fpos;
102         guint size;
103
104         MimeInfo *main;
105         MimeInfo *sub;
106
107         MimeInfo *next;
108         MimeInfo *parent;
109         MimeInfo *children;
110
111 #if USE_GPGME
112         MimeInfo *plaintext;
113         gchar *plaintextfile;
114         gchar *sigstatus;
115         gchar *sigstatus_full;
116 #endif
117
118         gint level;
119 };
120
121 #define IS_BOUNDARY(s, bnd, len) \
122         (bnd && s[0] == '-' && s[1] == '-' && !strncmp(s + 2, bnd, len))
123
124 /* MimeInfo handling */
125
126 MimeInfo *procmime_mimeinfo_new         (void);
127 void procmime_mimeinfo_free             (MimeInfo       *mimeinfo);
128 void procmime_mimeinfo_free_all         (MimeInfo       *mimeinfo);
129
130 MimeInfo *procmime_mimeinfo_insert      (MimeInfo       *parent,
131                                          MimeInfo       *mimeinfo);
132 void procmime_mimeinfo_replace          (MimeInfo       *old,
133                                          MimeInfo       *new);
134
135 MimeInfo *procmime_mimeinfo_next        (MimeInfo       *mimeinfo);
136
137 MimeInfo *procmime_scan_message         (MsgInfo        *msginfo);
138 void procmime_scan_multipart_message    (MimeInfo       *mimeinfo,
139                                          FILE           *fp);
140
141 /* scan headers */
142
143 void procmime_scan_encoding             (MimeInfo       *mimeinfo,
144                                          const gchar    *encoding);
145 void procmime_scan_content_type         (MimeInfo       *mimeinfo,
146                                          const gchar    *content_type);
147 void procmime_scan_content_disposition  (MimeInfo       *mimeinfo,
148                                          const gchar    *content_disposition);
149 void procmime_scan_content_description  (MimeInfo       *mimeinfo,
150                                          const gchar    *content_description);
151 void procmime_scan_subject              (MimeInfo       *mimeinfo,
152                                          const gchar    *subject);
153 MimeInfo *procmime_scan_mime_header     (FILE           *fp);
154
155 FILE *procmime_decode_content           (FILE           *outfp,
156                                          FILE           *infp,
157                                          MimeInfo       *mimeinfo);
158 gint procmime_get_part                  (const gchar    *outfile,
159                                          const gchar    *infile,
160                                          MimeInfo       *mimeinfo);
161 FILE *procmime_get_text_content         (MimeInfo       *mimeinfo,
162                                          FILE           *infp);
163 FILE *procmime_get_first_text_content   (MsgInfo        *msginfo);
164
165 gboolean procmime_find_string_part      (MimeInfo       *mimeinfo,
166                                          const gchar    *filename,
167                                          const gchar    *str,
168                                          gboolean        case_sens);
169 gboolean procmime_find_string           (MsgInfo        *msginfo,
170                                          const gchar    *str,
171                                          gboolean        case_sens);
172
173 gchar *procmime_get_tmp_file_name       (MimeInfo       *mimeinfo);
174
175 ContentType procmime_scan_mime_type     (const gchar    *mime_type);
176 gchar *procmime_get_mime_type           (const gchar    *filename);
177
178 GList *procmime_get_mime_type_list      (void);
179
180 EncodingType procmime_get_encoding_for_charset  (const gchar    *charset);
181 EncodingType procmime_get_encoding_for_file     (const gchar    *file);
182 const gchar *procmime_get_encoding_str          (EncodingType    encoding);
183
184 void renderer_read_config(void);
185 void renderer_write_config(void);
186
187 #endif /* __PROCMIME_H__ */