message-parser.h revision 0e0606d74a05d451b3438922b9a63ebf1755f838
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* Don't return message bodies in message_blocks. */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* Buggy software creates Content-Type: headers without Mime-Version:
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen header. By default we allow this and assume message is MIME if
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen Content-Type: is found. This flag disables this. */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen MESSAGE_PARSER_FLAG_MIME_VERSION_STRICT = 0x02,
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* Return multipart (preamble and epilogue) blocks */
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen MESSAGE_PARSER_FLAG_INCLUDE_MULTIPART_BLOCKS = 0x04
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen/* Note that these flags are used directly by message-parser-serialize, so
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen existing flags can't be changed without breaking backwards compatibility */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* content-type: text/... */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* message part header or body contains NULs */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* Mime-Version header exists. */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen uoff_t physical_pos; /* absolute position from beginning of message */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* Message part this block belongs to */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen /* non-NULL if a header line was read */
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen /* hdr = NULL, size = 0 block returned at the end of headers */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen const unsigned char *data;
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen/* called once with hdr = NULL at the end of headers */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainentypedef void message_part_header_callback_t(struct message_part *part,
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainenextern message_part_header_callback_t *null_message_part_header_callback;
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen/* Initialize message parser. part_spool specifies where struct message_parts
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen are allocated from. */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainenmessage_parser_init(pool_t part_pool, struct istream *input,
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen/* Use preparsed parts to speed up parsing. */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainenmessage_parser_init_from_parts(struct message_part *parts,
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen/* Returns 0 if parts were returned, -1 we used preparsed parts and they
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen didn't match the current message */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainenint message_parser_deinit(struct message_parser_ctx **ctx,
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen/* Read the next block of a message. Returns 1 if block is returned, 0 if
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen input stream is non-blocking and more data needs to be read, -1 when all is
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainen done or error occurred (see stream's error status). */
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainenint message_parser_parse_next_block(struct message_parser_ctx *ctx,
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen/* Read and parse header. */
e62f6437a4ff01d692a5a61369fe4168d69191edTimo Sirainenvoid message_parser_parse_header(struct message_parser_ctx *ctx,
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen# define message_parser_parse_header(ctx, hdr_size, callback, context) \
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen ({(void)(1 ? 0 : callback((struct message_part *)0, \
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen (message_part_header_callback_t *)callback, context); })
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen# define message_parser_parse_header(ctx, hdr_size, callback, context) \
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen (message_part_header_callback_t *)callback, context)
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen/* Read and parse body. If message is a MIME multipart or message/rfc822
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen message, hdr_callback is called for all headers. body_callback is called
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen for the body content. */
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainenvoid message_parser_parse_body(struct message_parser_ctx *ctx,
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen# define message_parser_parse_body(ctx, callback, context) \
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen ({(void)(1 ? 0 : callback((struct message_part *)0, \
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen (message_part_header_callback_t *)callback, context); })
74ab5ea66c0c4b388f1c774ae6a47ab94f1b4f18Timo Sirainen# define message_parser_parse_body(ctx, callback, context) \