| Top |
GObject
╰── GMimeObject
├── GMimeMessage
├── GMimePart
├── GMimeMultipart
╰── GMimeMessagePart
void (*GMimeObjectForeachFunc) (GMimeObject *parent,GMimeObject *part,gpointer user_data);
The function signature for a callback to g_mime_message_foreach()
and g_mime_multipart_foreach().
void g_mime_object_register_type (const char *type,const char *subtype,GType object_type);
Registers the object type object_type
for use with the
g_mime_object_new_type() convenience function.
Note: You may use the wildcard "*" to match any type and/or subtype.
GMimeObject *
g_mime_object_new (GMimeContentType *content_type);
Performs a lookup of registered GMimeObject subclasses, registered
using g_mime_object_register_type(), to find an appropriate class
capable of handling MIME parts of the specified Content-Type. If no
class has been registered to handle that type, it looks for a
registered class that can handle content_type
's media type. If
that also fails, then it will use the generic part class,
GMimePart.
GMimeObject * g_mime_object_new_type (const char *type,const char *subtype);
Performs a lookup of registered GMimeObject subclasses, registered
using g_mime_object_register_type(), to find an appropriate class
capable of handling MIME parts of type type
/subtype
. If no class
has been registered to handle that type, it looks for a registered
class that can handle type
. If that also fails, then it will use
the generic part class, GMimePart.
void g_mime_object_set_content_type (GMimeObject *object,GMimeContentType *content_type);
Sets the content-type for the specified MIME object and then serializes it to the Content-Type header field.
GMimeContentType *
g_mime_object_get_content_type (GMimeObject *object);
Gets the GMimeContentType object for the given MIME object or
NULL on fail.
void g_mime_object_set_content_type_parameter (GMimeObject *object,const char *name,const char *value);
Sets the content-type param name
to the value value
.
Note: The name
string should be in US-ASCII while the value
string should be in UTF-8.
const char * g_mime_object_get_content_type_parameter (GMimeObject *object,const char *name);
Gets the value of the content-type param name
set on the MIME part
object
.
void g_mime_object_set_disposition (GMimeObject *object,const char *disposition);
Sets the disposition to disposition
which may be one of
GMIME_DISPOSITION_ATTACHMENT or GMIME_DISPOSITION_INLINE or, by
your choice, any other string which would indicate how the MIME
part should be displayed by the MUA.
const char *
g_mime_object_get_disposition (GMimeObject *object);
Gets the MIME object's disposition if set or NULL otherwise.
the disposition string which is probably one of GMIME_DISPOSITION_ATTACHMENT or GMIME_DISPOSITION_INLINE.
void g_mime_object_set_content_disposition (GMimeObject *object,GMimeContentDisposition *disposition);
Set the content disposition for the specified mime part and then serializes it to the Content-Disposition header field.
GMimeContentDisposition *
g_mime_object_get_content_disposition (GMimeObject *object);
Gets the GMimeContentDisposition for the specified MIME object.
void g_mime_object_set_content_disposition_parameter (GMimeObject *object,const char *name,const char *value);
Add a content-disposition parameter to the specified mime part.
Note: The name
string should be in US-ASCII while the value
string should be in UTF-8.
const char * g_mime_object_get_content_disposition_parameter (GMimeObject *object,const char *name);
Gets the value of the Content-Disposition parameter specified by
name
, or NULL if the parameter does not exist.
void g_mime_object_set_content_id (GMimeObject *object,const char *content_id);
Sets the Content-Id of the MIME object.
const char *
g_mime_object_get_content_id (GMimeObject *object);
Gets the Content-Id of the MIME object or NULL if one is not set.
void g_mime_object_prepend_header (GMimeObject *object,const char *header,const char *value);
Prepends a raw, unprocessed header to the MIME object.
Note: value
should be encoded with a function such as
g_mime_utils_header_encode_text().
void g_mime_object_append_header (GMimeObject *object,const char *header,const char *value);
Appends a raw, unprocessed header to the MIME object.
Note: value
should be encoded with a function such as
g_mime_utils_header_encode_text().
gboolean g_mime_object_remove_header (GMimeObject *object,const char *header);
Removed the specified header if it exists.
void g_mime_object_set_header (GMimeObject *object,const char *header,const char *value);
Sets an arbitrary raw, unprocessed header on the MIME object.
Note: value
should be encoded with a function such as
g_mime_utils_header_encode_text().
const char * g_mime_object_get_header (GMimeObject *object,const char *header);
Gets the raw, unprocessed value of the first header with the specified name.
the raw, unprocessed value of the requested header if it
exists or NULL otherwise.
Note: The returned value should be decoded with a function such as
g_mime_utils_header_decode_text() before displaying to the user.
char *
g_mime_object_get_headers (GMimeObject *object);
Allocates a string buffer containing all of the MIME object's raw headers.
GMimeHeaderList *
g_mime_object_get_header_list (GMimeObject *object);
Get the header list for object
.
ssize_t g_mime_object_write_to_stream (GMimeObject *object,GMimeStream *stream);
Write the contents of the MIME object to stream
.
char *
g_mime_object_to_string (GMimeObject *object);
Allocates a string buffer containing the contents of object
.
void g_mime_object_encode (GMimeObject *object,GMimeEncodingConstraint constraint);
Calculates and sets the most efficient Content-Transfer-Encoding
for this GMimeObject and all child parts based on the constraint
provided.