aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-mime-part.h
blob: 785fecf9d9739674c57bcefd15d58961cc8a0ffc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */
/* camel-mime-part.h : class for a mime part */

/* 
 *
 * Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
 *      Michael Zucchi <notzed@ximian.com>
 *
 * Copyright 1999, 2000 Ximian, Inc. (www.ximian.com)
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of version 2 of the GNU General Public 
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */


#ifndef CAMEL_MIME_PART_H
#define CAMEL_MIME_PART_H 1


#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/

#include <camel/camel-medium.h>
#include <camel/camel-mime-utils.h>
#include <camel/camel-mime-parser.h>

#define CAMEL_MIME_PART_TYPE     (camel_mime_part_get_type ())
#define CAMEL_MIME_PART(obj)     (CAMEL_CHECK_CAST((obj), CAMEL_MIME_PART_TYPE, CamelMimePart))
#define CAMEL_MIME_PART_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_MIME_PART_TYPE, CamelMimePartClass))
#define CAMEL_IS_MIME_PART(o)    (CAMEL_CHECK_TYPE((o), CAMEL_MIME_PART_TYPE))

/* note, if you change this, make sure you change the 'encodings' array in camel-mime-part.c */
enum _CamelMimePartEncodingType {
        CAMEL_MIME_PART_ENCODING_DEFAULT,
        CAMEL_MIME_PART_ENCODING_7BIT,
        CAMEL_MIME_PART_ENCODING_8BIT,
        CAMEL_MIME_PART_ENCODING_BASE64,
        CAMEL_MIME_PART_ENCODING_QUOTEDPRINTABLE,
        CAMEL_MIME_PART_ENCODING_BINARY,
        CAMEL_MIME_PART_NUM_ENCODINGS
};
typedef enum _CamelMimePartEncodingType CamelMimePartEncodingType;


/* Do not change these values directly, you would regret it one day */
struct _CamelMimePart
{
    CamelMedium parent_object;

    CamelContentType *content_type;
    struct _header_raw *headers; /* mime headers */
    
    /* All fields here are -** PRIVATE **- */
    char *description;
    CamelMimeDisposition *disposition;
    char *content_id;
    char *content_MD5;
    char *content_location;
    GList *content_languages;
    CamelMimePartEncodingType encoding;
};

typedef struct _CamelMimePartClass {
    CamelMediumClass parent_class;
    
    /* Virtual methods */
    int (*construct_from_parser) (CamelMimePart *, CamelMimeParser *);
} CamelMimePartClass;

/* Standard Camel function */
CamelType camel_mime_part_get_type (void);

/* public methods */
CamelMimePart *  camel_mime_part_new                    (void);

void             camel_mime_part_set_description    (CamelMimePart *mime_part, const gchar *description);
const     gchar *camel_mime_part_get_description    (CamelMimePart *mime_part);

void             camel_mime_part_set_disposition    (CamelMimePart *mime_part, const gchar *disposition);
const     gchar *camel_mime_part_get_disposition    (CamelMimePart *mime_part);

void             camel_mime_part_set_filename       (CamelMimePart *mime_part, const gchar *filename);
const     gchar *camel_mime_part_get_filename       (CamelMimePart *mime_part);

void             camel_mime_part_set_content_id     (CamelMimePart *mime_part, const char *contentid);
const     gchar *camel_mime_part_get_content_id     (CamelMimePart *mime_part);

void         camel_mime_part_set_content_MD5    (CamelMimePart *mime_part, const char *);
const     gchar *camel_mime_part_get_content_MD5    (CamelMimePart *mime_part);

void         camel_mime_part_set_content_location   (CamelMimePart *mime_part, const char *);
const     gchar *camel_mime_part_get_content_location   (CamelMimePart *mime_part);

void             camel_mime_part_set_encoding       (CamelMimePart *mime_part, CamelMimePartEncodingType type);
CamelMimePartEncodingType camel_mime_part_get_encoding  (CamelMimePart *mime_part);

void         camel_mime_part_set_content_languages  (CamelMimePart *mime_part, GList *content_languages);
const     GList *camel_mime_part_get_content_languages  (CamelMimePart *mime_part);

/* FIXME: what about content-type parameters?   what about major/minor parts? */
void               camel_mime_part_set_content_type     (CamelMimePart *mime_part, gchar *content_type);
CamelContentType  *camel_mime_part_get_content_type (CamelMimePart *mime_part);

const     gchar *         camel_mime_part_encoding_to_string   (CamelMimePartEncodingType encoding);
CamelMimePartEncodingType camel_mime_part_encoding_from_string (const gchar *string);

/* construction */
int     camel_mime_part_construct_from_parser  (CamelMimePart *, CamelMimeParser *);

/* utility functions */
void        camel_mime_part_set_content            (CamelMimePart *camel_mime_part,
                            const char *content, int length, const char *type);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CAMEL_MIME_PART_H */