Creates a new MIME message/partial object.
message/partial part id
message/partial part number
total number of message/partial parts
a #GMimeDataWrapper representing the MIME part's content
Content-Description string
a Content-Id
Content-Location string
Content-MD5 string
a #GMimeContentType
a #GMimeContentDisposition
a #GMimeContentEncoding
a #GMimeHeaderList
message/partial id
the part number
a #GMimeOpenPGPData
parent #GMimePart object
the total number of message/partials that make up the whole message/rfc822
Appends a new header to the header list.
header name
header value
a charset
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Calculates and sets the most efficient Content-Transfer-Encoding
for this #GMimeObject and all child parts based on the constraint
provided.
a #GMimeEncodingConstraint
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Calculates the most efficient content encoding for the mime_part
given the constraint
.
a #GMimeEncodingConstraint
Gets the internal data-wrapper of the specified mime part, or %NULL on error.
Gets the value of the Content-Description for the specified mime part if it exists or %NULL otherwise.
Gets the #GMimeContentDisposition for the specified MIME object.
Gets the value of the Content-Disposition parameter specified by
name,
or %NULL if the parameter does not exist.
parameter name
Gets the content encoding of the mime part.
Gets the content-id of the specified mime part if it exists, or %NULL otherwise.
Gets the value of the Content-Location header if it exists, or %NULL otherwise.
Gets the md5sum contained in the Content-Md5 header of the specified mime part if it exists, or %NULL otherwise.
Gets the #GMimeContentType object for the given MIME object or %NULL on fail.
Gets the value of the content-type param name
set on the MIME part
object
.
param name
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Gets the MIME object's disposition if set or %NULL otherwise.
Gets the filename of the specificed mime part, or %NULL if the
mime_part
does not have the filename or name parameter set.
Gets the value of the first header with the specified name.
header name
Get the header list for object
.
Allocates a string buffer containing all of the MIME object's raw headers.
a #GMimeFormatOptions or %NULL
Gets the message/partial id parameter value.
Gets the message/partial part number.
Gets whether or not (and what type) of OpenPGP data is contained within the #GMimePart.
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Gets the total number of message/partial parts needed to reconstruct the original message.
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Determines whether or not the part is an attachment based on the value of the Content-Disposition header.
Checks whether object
has a [floating][floating-ref] reference.
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Decrypts the content of the mime_part
and then replaces the content with
the new, decrypted, content.
a set of #GMimeDecryptFlags
the session key to use or %NULL
Encrypts (and optionally signs) the content of the mime_part
and then replaces
the content with the new, encrypted, content.
%TRUE if the content should also be signed; otherwise, %FALSE
the key id (or email address) to use when signing (assuming sign
is %TRUE)
a set of #GMimeEncryptFlags
an array of recipient key ids and/or email addresses
Signs the content of the mime_part
and then replaces the content with
the new, signed, content.
the key id (or email address) to use for signing
Verifies the OpenPGP signature of the mime_part
and then replaces the content
with the original, raw, content.
a set of #GMimeVerifyFlags
Prepends a new header to the header list.
header name
header value
a charset
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
Removed the specified header if it exists.
header name
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets the content on the mime part.
a #GMimeDataWrapper content object
Set the content description for the specified mime part.
content description
Set the content disposition for the specified mime part and then serializes it to the Content-Disposition header field.
a #GMimeContentDisposition object
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.
parameter name
parameter value
Set the content encoding for the specified mime part.
a #GMimeContentEncoding
Set the content id for the specified mime part.
content id
Set the content location for the specified mime part.
content location
Set the content md5 for the specified mime part.
content md5 or %NULL to generate the md5 digest.
Sets the content-type for the specified MIME object and then serializes it to the Content-Type header field.
a #GMimeContentType object
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.
param name
param value
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
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.
disposition ("attachment" or "inline")
Sets the "filename" parameter on the Content-Disposition and also sets the "name" parameter on the Content-Type.
Note: The filename
string should be in UTF-8.
the file name
Sets a header to the specified value.
header name
header value
a charset
Sets whether or not (and what type) of OpenPGP data is contained within the #GMimePart.
a #GMimeOpenPGPData
Sets a property on an object.
the name of the property to set
the value
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Allocates a string buffer containing the contents of object
.
a #GMimeFormatOptions or %NULL
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Verify the content md5 for the specified mime part.
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Write only the content of the MIME object to stream
.
a #GMimeFormatOptions or %NULL
stream
Write the headers and content of the MIME object to stream
.
a #GMimeFormatOptions or %NULL
stream
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new MIME message/partial object.
message/partial part id
message/partial part number
total number of message/partial parts
Creates a new MIME Part object with a default content-type of application/octet-stream.
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.
a #GMimeParserOptions or %NULL
a #GMimeContentType object
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.
a #GMimeParserOptions or %NULL
mime type
mime subtype
Creates a new MIME Part with a sepcified type.
content-type string
content-subtype string
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Reconstructs the GMimeMessage from the given message/partial parts
in partials
.
an array of message/partial mime parts
the number of elements in partials
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.
mime type
mime subtype
object type
A message/partial MIME part.