gmime-header

Name

gmime-header -- 

Synopsis



void        (*GMimeHeaderFunc)              (const gchar *name,
                                             const gchar *value,
                                             gpointer data);
GMimeHeader* g_mime_header_new              (void);
void        g_mime_header_destroy           (GMimeHeader *header);
void        g_mime_header_set               (GMimeHeader *header,
                                             const gchar *name,
                                             const gchar *value);
const gchar* g_mime_header_get              (const GMimeHeader *header,
                                             const gchar *name);
void        g_mime_header_remove            (GMimeHeader *header,
                                             const gchar *name);
void        g_mime_header_write_to_string   (const GMimeHeader *header,
                                             GString *string);
gchar*      g_mime_header_to_string         (const GMimeHeader *header);
void        g_mime_header_foreach           (const GMimeHeader *header,
                                             GMimeHeaderFunc func,
                                             gpointer data);

Description

Details

GMimeHeaderFunc ()

void        (*GMimeHeaderFunc)              (const gchar *name,
                                             const gchar *value,
                                             gpointer data);

name : 
value : 
data : 


g_mime_header_new ()

GMimeHeader* g_mime_header_new              (void);

Returns :a new header object.


g_mime_header_destroy ()

void        g_mime_header_destroy           (GMimeHeader *header);

Destroy the header object

header : header object


g_mime_header_set ()

void        g_mime_header_set               (GMimeHeader *header,
                                             const gchar *name,
                                             const gchar *value);

Set the value of the specified header. If value is NULL and the header, name, had not been previously set, a space will be set aside for it (useful for setting the order of headers before values can be obtained for them) otherwise the header will be unset.

header : header object
name : header name
value : header value


g_mime_header_get ()

const gchar* g_mime_header_get              (const GMimeHeader *header,
                                             const gchar *name);

header : header object
name : header name
Returns :the value of the header requested


g_mime_header_remove ()

void        g_mime_header_remove            (GMimeHeader *header,
                                             const gchar *name);

Remove the specified header

header : header object
name : header name


g_mime_header_write_to_string ()

void        g_mime_header_write_to_string   (const GMimeHeader *header,
                                             GString *string);

Write the headers to a string

header : header object
string : string


g_mime_header_to_string ()

gchar*      g_mime_header_to_string         (const GMimeHeader *header);

header : header object
Returns :a string containing the header block


g_mime_header_foreach ()

void        g_mime_header_foreach           (const GMimeHeader *header,
                                             GMimeHeaderFunc func,
                                             gpointer data);

Calls func for each header name/value pair.

header : header object
func : function to be called for each header.
data : User data to be passed to the func.