gmime-parser

Name

gmime-parser -- 

Synopsis



struct      GMimeParser;
GMimeParser* g_mime_parser_new              (void);
void        g_mime_parser_init_with_stream  (GMimeParser *parser,
                                             GMimeStream *stream);
void        g_mime_parser_set_scan_from     (GMimeParser *parser,
                                             gboolean scan_from);
gboolean    g_mime_parser_get_scan_from     (GMimeParser *parser);
off_t       g_mime_parser_tell              (GMimeParser *parser);
gboolean    g_mime_parser_eos               (GMimeParser *parser);
GMimeObject* g_mime_parser_construct_part   (GMimeParser *parser);
GMimeMessage* g_mime_parser_construct_message
                                            (GMimeParser *parser);
char*       g_mime_parser_get_from          (GMimeParser *parser);


Description

Details

struct GMimeParser

struct GMimeParser {
	GObject parent_object;
	
	struct _GMimeParserPrivate *priv;
};


g_mime_parser_new ()

GMimeParser* g_mime_parser_new              (void);

Creates a new parser object.

Returns :a new parser object.


g_mime_parser_init_with_stream ()

void        g_mime_parser_init_with_stream  (GMimeParser *parser,
                                             GMimeStream *stream);

Initializes parser to use stream.

WARNING: Initializing a parser with a stream is comparable to selling your soul (stream) to the devil (parser). You are basically giving the parser complete control of the stream, this means that you had better not touch the stream so long as the parser is still using it. This means no reading, writing, seeking, or resetting of the stream. Anything that will/could change the current stream's offset is PROHIBITED.

It is also recommended that you not use g_mime_stream_tell because it will not necessarily give you the current parser offset since parser handles its own internal read-ahead buffer. Instead, it is recommended that you use g_mime_parser_tell if you have a reason to need the current offset of the parser.

parser : MIME parser object
stream : raw message or part stream


g_mime_parser_set_scan_from ()

void        g_mime_parser_set_scan_from     (GMimeParser *parser,
                                             gboolean scan_from);

Sets whether or not parser should scan mbox-style From-lines.

parser : MIME parser object
scan_from : TRUE to scan From-lines or FALSE otherwise


g_mime_parser_get_scan_from ()

gboolean    g_mime_parser_get_scan_from     (GMimeParser *parser);

Gets whether or not parser is set to scan mbox-style From-lines.

parser : MIME parser object
Returns :whether or not parser is set to scan mbox-style From-lines.


g_mime_parser_tell ()

off_t       g_mime_parser_tell              (GMimeParser *parser);

Gets the current stream offset from the parser's internal stream.

parser : MIME parser object
Returns :the current stream offset from the parser's internal stream or -1 on error.


g_mime_parser_eos ()

gboolean    g_mime_parser_eos               (GMimeParser *parser);

Tests the end-of-stream indicator for parser's internal stream.

parser : MIME parser
Returns :TRUE on EOS or FALSE otherwise.


g_mime_parser_construct_part ()

GMimeObject* g_mime_parser_construct_part   (GMimeParser *parser);

Constructs a MIME part from parser.

parser : MIME parser object
Returns :a MIME part based on parser or NULL on fail.


g_mime_parser_construct_message ()

GMimeMessage* g_mime_parser_construct_message
                                            (GMimeParser *parser);

Constructs a MIME message from parser.

parser : MIME parser object
Returns :a MIME message or NULL on fail.


g_mime_parser_get_from ()

char*       g_mime_parser_get_from          (GMimeParser *parser);

Gets the mbox-style From-line of the most recently parsed message (gotten from g_mime_parser_construct_message).

parser : MIME parser object
Returns :the mbox-style From-line of the most recently parsed message or NULL on error.