GMimeContentType

GMimeContentType — Content-Type fields

Synopsis

                    GMimeContentType;
GMimeContentType*   g_mime_content_type_new             (const char *type,
                                                         const char *subtype);
GMimeContentType*   g_mime_content_type_new_from_string (const char *str);
char*               g_mime_content_type_to_string       (GMimeContentType *mime_type);
gboolean            g_mime_content_type_is_type         (GMimeContentType *mime_type,
                                                         const char *type,
                                                         const char *subtype);
const char*         g_mime_content_type_get_media_type  (GMimeContentType *mime_type);
void                g_mime_content_type_set_media_type  (GMimeContentType *mime_type,
                                                         const char *type);
const char*         g_mime_content_type_get_media_subtype
                                                        (GMimeContentType *mime_type);
void                g_mime_content_type_set_media_subtype
                                                        (GMimeContentType *mime_type,
                                                         const char *subtype);
const GMimeParam*   g_mime_content_type_get_params      (GMimeContentType *mime_type);
void                g_mime_content_type_set_params      (GMimeContentType *mime_type,
                                                         GMimeParam *params);
const char*         g_mime_content_type_get_parameter   (GMimeContentType *mime_type,
                                                         const char *attribute);
void                g_mime_content_type_set_parameter   (GMimeContentType *mime_type,
                                                         const char *attribute,
                                                         const char *value);

Object Hierarchy

  GObject
   +----GMimeContentType

Description

A GMimeContentType represents the pre-parsed contents of a Content-Type header field.

Details

GMimeContentType

typedef struct _GMimeContentType GMimeContentType;

A data structure representing a Content-Type.

g_mime_content_type_new ()

GMimeContentType*   g_mime_content_type_new             (const char *type,
                                                         const char *subtype);

Creates a Content-Type object with type type and subtype subtype.

type :

 MIME type (or NULL for "text")

subtype :

 MIME subtype (or NULL for "plain")

Returns :

 a new GMimeContentType object.

g_mime_content_type_new_from_string ()

GMimeContentType*   g_mime_content_type_new_from_string (const char *str);

Constructs a new Content-Type object based on the input string.

str :

 input string containing a content-type (and params)

Returns :

 a new GMimeContentType object based on the input string.

g_mime_content_type_to_string ()

char*               g_mime_content_type_to_string       (GMimeContentType *mime_type);

Allocates a string buffer containing the type and subtype defined by the mime_type.

mime_type :

 a GMimeContentType object

Returns :

 an allocated string containing the type and subtype of the content-type in the format: type/subtype.

g_mime_content_type_is_type ()

gboolean            g_mime_content_type_is_type         (GMimeContentType *mime_type,
                                                         const char *type,
                                                         const char *subtype);

Compares the given type and subtype with that of the given mime type object.

mime_type :

 a GMimeContentType object

type :

 MIME type to compare against

subtype :

 MIME subtype to compare against

Returns :

 TRUE if the MIME types match or FALSE otherwise. You may use "*" in place of type and/or subtype as a wilcard.

g_mime_content_type_get_media_type ()

const char*         g_mime_content_type_get_media_type  (GMimeContentType *mime_type);

Gets the Content-Type's media type.

mime_type :

 a GMimeContentType object

Returns :

 the Content-Type's media type.

g_mime_content_type_set_media_type ()

void                g_mime_content_type_set_media_type  (GMimeContentType *mime_type,
                                                         const char *type);

Sets the Content-Type's media type.

mime_type :

 a GMimeContentType object

type :

 media type

g_mime_content_type_get_media_subtype ()

const char*         g_mime_content_type_get_media_subtype
                                                        (GMimeContentType *mime_type);

Gets the Content-Type's media sub-type.

mime_type :

 a GMimeContentType object

Returns :

 the Content-Type's media sub-type.

g_mime_content_type_set_media_subtype ()

void                g_mime_content_type_set_media_subtype
                                                        (GMimeContentType *mime_type,
                                                         const char *subtype);

Sets the Content-Type's media subtype.

mime_type :

 a GMimeContentType object

subtype :

 media subtype

g_mime_content_type_get_params ()

const GMimeParam*   g_mime_content_type_get_params      (GMimeContentType *mime_type);

Gets the Content-Type's parameter list.

mime_type :

 a GMimeContentType object

Returns :

 the Content-Type's parameter list.

g_mime_content_type_set_params ()

void                g_mime_content_type_set_params      (GMimeContentType *mime_type,
                                                         GMimeParam *params);

Sets the Content-Type's parameter list.

mime_type :

 a GMimeContentType object

params :

 a list of GMimeParam objects

g_mime_content_type_get_parameter ()

const char*         g_mime_content_type_get_parameter   (GMimeContentType *mime_type,
                                                         const char *attribute);

Gets the parameter value specified by attribute if it's available.

mime_type :

 a GMimeContentType object

attribute :

 parameter name (aka attribute)

Returns :

 a const pointer to the paramer value specified by attribute or NULL on fail.

g_mime_content_type_set_parameter ()

void                g_mime_content_type_set_parameter   (GMimeContentType *mime_type,
                                                         const char *attribute,
                                                         const char *value);

Sets a parameter on the Content-Type.

mime_type :

 MIME Content-Type

attribute :

 parameter name (aka attribute)

value :

 parameter value
Generated by GTK-Doc V1.10