aboutsummaryrefslogtreecommitdiffstats
path: root/em-format/e-mail-parser-extension.h
blob: 101c1320dc654f51e2f8284dbbd609503f69c6cb (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
/*
 * e-mail-parser-extension.h
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 */

#ifndef E_MAIL_PARSER_EXTENSION_H
#define E_MAIL_PARSER_EXTENSION_H

#include <em-format/e-mail-extension.h>
#include <em-format/e-mail-parser.h>
#include <camel/camel.h>

/* Standard GObject macros */
#define E_TYPE_MAIL_PARSER_EXTENSION \
    (e_mail_parser_extension_get_type ())
#define E_MAIL_PARSER_EXTENSION(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_MAIL_PARSER_EXTENSION, EMailParserExtension))
#define E_MAIL_PARSER_EXTENSION_INTERFACE(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_MAIL_PARSER_EXTENSION, EMailParserExtensionInterface))
#define E_IS_MAIL_PARSER_EXTENSION(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_MAIL_PARSER_EXTENSION))
#define E_IS_MAIL_PARSER_EXTENSION_INTERFACE(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_MAIL_PARSER_EXTENSION))
#define E_MAIL_PARSER_EXTENSION_GET_INTERFACE(obj) \
    (G_TYPE_INSTANCE_GET_INTERFACE \
    ((obj), E_TYPE_MAIL_PARSER_EXTENSION, EMailParserExtensionInterface))

#define EMP_EXTENSION_GET_PARSER(e) \
    E_MAIL_PARSER (e_extension_get_extensible (E_EXTENSION (e)))

G_BEGIN_DECLS

typedef struct _EMailParserExtension EMailParserExtension;
typedef struct _EMailParserExtensionInterface EMailParserExtensionInterface;

/**
 * EMailParserExtensionFlags:
 * @E_MAIL_PARSER_EXTENSION_INLINE:
 *    Don't parse as attachment.
 * @E_MAIL_PARSER_EXTENSION_INLINE_DISPOSITION:
 *    Always expand.
 * @E_MAIL_PARSER_EXTENSION_COMPOUND_TYPE:
 *    Always check what's inside.
 **/
typedef enum {
    E_MAIL_PARSER_EXTENSION_INLINE          = 1 << 0,
    E_MAIL_PARSER_EXTENSION_INLINE_DISPOSITION  = 1 << 1,
    E_MAIL_PARSER_EXTENSION_COMPOUND_TYPE       = 1 << 2
} EMailParserExtensionFlags;

struct _EMailParserExtensionInterface {
    EMailExtensionInterface parent_interface;

    GSList *    (*parse)    (EMailParserExtension *extension,
                     EMailParser *parser,
                     CamelMimePart *mime_part,
                     GString *part_id,
                     GCancellable *cancellable);

    guint32     (*get_flags)    (EMailParserExtension *extension);

};

GType       e_mail_parser_extension_get_type
                        (void) G_GNUC_CONST;
GSList *    e_mail_parser_extension_parse   (EMailParserExtension *extension,
                         EMailParser *parser,
                         CamelMimePart *mime_part,
                         GString *part_id,
                         GCancellable *cancellable);
guint32     e_mail_parser_extension_get_flags
                        (EMailParserExtension *extension);

G_END_DECLS

#endif /* E_MAIL_PARSER_EXTENSION_H */