make address functions a lot better, and less error prone.
[apps/madmutt.git] / lib-mime / mime.h
1 /*
2  *  This program is free software; you can redistribute it and/or modify
3  *  it under the terms of the GNU General Public License as published by
4  *  the Free Software Foundation; either version 2 of the License, or (at
5  *  your option) any later version.
6  *
7  *  This program is distributed in the hope that it will be useful, but
8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
10  *  General Public License for more details.
11  *
12  *  You should have received a copy of the GNU General Public License
13  *  along with this program; if not, write to the Free Software
14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
15  *  MA 02110-1301, USA.
16  *
17  *  Copyright © 2006 Pierre Habouzit
18  */
19
20 /*
21  * Copyright notice from original mutt:
22  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
23  *
24  * This file is part of mutt-ng, see http://www.muttng.org/.
25  * It's licensed under the GNU General Public License,
26  * please see the file GPL in the top level source directory.
27  */
28
29 #ifndef MUTT_LIB_MIME_MIME_H
30 #define MUTT_LIB_MIME_MIME_H
31
32 #include <stdlib.h>
33
34 #include <lib-lib/mem.h>
35 #include <lib-lib/list.h>
36
37 /* Content-Type */
38 enum {
39     TYPEOTHER,
40     TYPEAUDIO,
41     TYPEAPPLICATION,
42     TYPEIMAGE,
43     TYPEMESSAGE,
44     TYPEMODEL,
45     TYPEMULTIPART,
46     TYPETEXT,
47     TYPEVIDEO,
48     TYPEANY
49 };
50
51 /* Content-Transfer-Encoding */
52 enum {
53     ENCOTHER,
54     ENC7BIT,
55     ENC8BIT,
56     ENCQUOTEDPRINTABLE,
57     ENCBASE64,
58     ENCBINARY,
59     ENCUUENCODED
60 };
61
62 /* Content-Disposition values */
63 enum {
64     DISPINLINE,
65     DISPATTACH,
66     DISPFORMDATA
67 };
68
69 typedef struct parameter {
70     char *attribute;
71     char *value;
72     struct parameter *next;
73 } PARAMETER;
74
75 extern const char MimeSpecials[];
76 extern const char *BodyTypes[];
77 extern const char *BodyEncodings[];
78
79 /* MIME encoding/decoding global vars */
80
81 #define is_multipart(x) \
82     ((x)->type == TYPEMULTIPART \
83      || ((x)->type == TYPEMESSAGE && (!strcasecmp((x)->subtype, "rfc822") \
84                                       || !strcasecmp((x)->subtype, "news"))))
85 #define TYPE(X) ((X->type == TYPEOTHER) && (X->xtype != NULL) ? X->xtype : BodyTypes[(X->type)])
86 #define ENCODING(X) BodyEncodings[(X)]
87
88 /****************************************************************************/
89 /* RFC 822                                                                  */
90 /*                Standard for ARPA Internet Text Messages                  */
91 /****************************************************************************/
92
93 /* possible values for RFC822Error */
94 enum {
95     ERR_MEMORY = 1,
96     ERR_MISMATCH_PAREN,
97     ERR_MISMATCH_QUOTE,
98     ERR_BAD_ROUTE,
99     ERR_BAD_ROUTE_ADDR,
100     ERR_BAD_ADDR_SPEC
101 };
102
103 typedef struct address_t {
104     char *personal;               /* real name of address */
105     char *mailbox;                /* mailbox and host address */
106     int group;                    /* group mailbox? */
107     struct address_t *next;
108 } address_t;
109
110 DO_INIT(address_t, address);
111 void address_wipe(address_t *);
112
113 DO_NEW(address_t, address);
114 DO_DELETE(address_t, address);
115 DO_SLIST(address_t, address);
116
117 address_t *address_dup(address_t *addr);
118 address_t *address_list_dup(address_t *addr);
119
120 void rfc822_qualify(address_t *, const char *);
121
122 address_t *rfc822_parse_adrlist(address_t *, const char *s);
123 void rfc822_write_address(char *, size_t, address_t *, int);
124 void rfc822_write_address_single(char *, size_t, address_t *, int);
125 void rfc822_cat(char *, size_t, const char *, const char *);
126
127 extern int RFC822Error;
128 extern const char *RFC822Errors[];
129 extern const char RFC822Specials[];
130
131 #define rfc822_error(x) RFC822Errors[x]
132
133 /****************************************************************************/
134 /* RFC 2231                                                                 */
135 /*             MIME Parameter Value and Encoded Word Extensions:            */
136 /*               Character Sets, Languages, and Continuations               */
137 /****************************************************************************/
138
139 int  rfc2231_encode_string(char **);
140 void rfc2231_decode_parameters(PARAMETER **);
141
142 #endif /* MUTT_LIB_MIME_MIME_H */