Asynchronously attempts to authenticate service
using mechanism
and,
if necessary, service'
s #CamelService:password property. The function
makes only ONE attempt at authentication and does not loop.
Generally this function should only be called from a #CamelSession subclass in order to implement its own authentication loop.
When the operation is finished, callback
will be called. You can
then call camel_service_authenticate_finish() to get the result of
the operation.
a SASL mechanism name, or %NULL
the I/O priority of the request
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Finishes the operation started with camel_service_authenticate().
If the authentication attempt completed and the server accepted the credentials, the function returns #CAMEL_AUTHENTICATION_ACCEPTED.
If the authentication attempt completed but the server rejected the credentials, the function returns #CAMEL_AUTHENTICATION_REJECTED.
If the authentication attempt failed to complete due to a network
communication issue or some other mishap, the function sets error
and returns #CAMEL_AUTHENTICATION_ERROR.
a #GAsyncResult
Attempts to authenticate service
using mechanism
and, if necessary,
service'
s #CamelService:password property. The function makes only
ONE attempt at authentication and does not loop.
If the authentication attempt completed and the server accepted the credentials, the function returns #CAMEL_AUTHENTICATION_ACCEPTED.
If the authentication attempt completed but the server rejected the credentials, the function returns #CAMEL_AUTHENTICATION_REJECTED.
If the authentication attempt failed to complete due to a network
communication issue or some other mishap, the function sets error
and returns #CAMEL_AUTHENTICATION_ERROR.
Generally this function should only be called from a #CamelSession subclass in order to implement its own authentication loop.
a SASL mechanism name, or %NULL
optional #GCancellable object, or %NULL
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
Asynchronously attempts to determine whether or not the host described by
service'
s #CamelNetworkService:connectable property can be reached, without
actually trying to connect to it.
For more details, see camel_network_service_can_reach_sync().
When the operation is finished, callback
will be called. You can then
call camel_network_service_can_reach_finish() to get the result of the
operation.
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Finishes the operation started with camel_network_service_can_reach().
a #GAsyncResult
Attempts to determine whether or not the host described by service'
s
#CamelNetworkService:connectable property can be reached, without actually
trying to connect to it.
If service
believes an attempt to connect will succeed, the function
returns %TRUE. Otherwise the function returns %FALSE and sets error
to an appropriate error (such as %G_IO_ERROR_HOST_UNREACHABLE).
The function will also update the service'
s
#CamelNetworkService:host-reachable property based on the result.
optional #GCancellable object, or %NULL
Finishes the operation started with camel_service_connect().
a #GAsyncResult
Attempts to establish a network connection to the server described by
service,
using the preferred #CamelNetworkSettings:security-method to
secure the connection. If a connection cannot be established, or the
connection attempt is cancelled, the function sets error
and returns
%NULL.
optional #GCancellable object, or %NULL
Connects service
to a remote server using the information in its
#CamelService:settings instance.
If a connect operation is already in progress when this function is called, its results will be reflected in this connect operation.
optional #GCancellable object, or %NULL
Finishes the operation started with camel_service_disconnect().
a #GAsyncResult
Disconnect from the service. If clean
is %FALSE, it should not
try to do any synchronizing or other cleanup of the connection.
If a disconnect operation is already in progress when this function is called, its results will be reflected in this disconnect operation.
If any connect operations are in progress when this function is called, they will be cancelled.
whether or not to try to disconnect cleanly
optional #GCancellable object, or %NULL
Thread-safe variation of camel_service_get_display_name().
Use this function when accessing service
from multiple threads.
The returned string should be freed with g_free() when no longer needed.
Thread-safe variation of camel_service_get_password().
Use this function when accessing service
from multiple threads.
The returned string should be freed with g_free() when no longer needed.
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.
Returns the connection status for service
.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns the default network port number for service
and the security
method method,
as defined in /etc/services. For example, the default
port for unencrypted IMAP or encrypted IMAP using STARTTLS is 143, but
the default port for IMAP over SSL is 993.
a #CamelNetworkSecurityMethod
Returns the display name for service,
or %NULL if service
has not
been given a display name. The display name is intended for use in
a user interface and should generally be given a user-defined name.
Compare this with camel_service_get_name(), which returns a built-in description of the type of service (IMAP, SMTP, etc.).
Returns %TRUE if service
believes that the host pointed to by
#CamelNetworkService:connectable can be reached. This property
is updated automatically as network conditions change.
This gets the name of the service in a "friendly" (suitable for
humans) form. If brief
is %TRUE, this should be a brief description
such as for use in the folder tree. If brief
is %FALSE, it should
be a more complete and mostly unambiguous description.
whether or not to use a briefer form
Returns the password for service
. Some SASL mechanisms use this
when attempting to authenticate.
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
Returns the standard network service name for service
and the security
method method,
as defined in /etc/services. For example, the service
name for unencrypted IMAP or encrypted IMAP using STARTTLS is "imap",
but the service name for IMAP over SSL is "imaps".
a #CamelNetworkSecurityMethod
Returns the name of the file in which persistent property values for
object
are stored. The file is used by camel_object_state_write()
and camel_object_state_read() to save and restore object state.
Gets the unique identifier string associated with the service.
Returns the base directory under which to store cache data
for service
. The directory is formed by appending the directory
returned by camel_session_get_user_cache_dir() with the service's
#CamelService:uid value.
Returns the base directory under which to store user-specific data
for service
. The directory is formed by appending the directory
returned by camel_session_get_user_data_dir() with the service's
#CamelService:uid value.
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
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable
is not %NULL,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. If cancellable
is not %NULL and
the object doesn't support cancellable initialization the error
%G_IO_ERROR_NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.
Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.
optional #GCancellable object, %NULL to ignore.
Checks whether object
has a [floating][floating-ref] reference.
Performs any necessary file migrations for service
. This should be
called after installing or configuring the service'
s #CamelSettings,
since it requires building a URL string for service
.
Returns a new #CamelURL representing service
.
Free the returned #CamelURL with camel_url_free().
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
.
Asynchronously obtains a list of authentication types supported by
service
.
When the operation is finished, callback
will be called. You can
then call camel_service_query_auth_types_finish() to get the result
of the operation.
the I/O priority of the request
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Finishes the operation started with camel_service_query_auth_types(). Free the returned list with g_list_free().
a #GAsyncResult
Obtains a list of authentication types supported by service
.
Free the returned list with g_list_free().
optional #GCancellable object, or %NULL
Adds task
to a queue of waiting tasks with the same source object.
Queued tasks execute one at a time in the order they were added. When
task
reaches the front of the queue, it will be dispatched by invoking
task_func
in a separate thread. If task
is cancelled while queued,
it will complete immediately with an appropriate error.
This is primarily intended for use by #CamelStore, #CamelTransport and #CamelFolder to achieve ordered invocation of synchronous class methods.
a #GTask
function to call when task
is dispatched
Returns the socket endpoint for the network service to which service
is a client.
The returned #GSocketConnectable is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
Returns the #GProxyResolver for service
. If an application needs to
override this, it should do so prior to calling functions on service
that may require a network connection.
The returned #GProxyResolver is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
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().
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 socket endpoint for the network service to which service
is
a client. If connectable
is %NULL, a #GSocketConnectable is derived
from the service'
s #CamelNetworkSettings.
a #GSocketConnectable, or %NULL
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
Assigns a UTF-8 display name to service
. The display name is intended
for use in a user interface and should generally be given a user-defined
name.
Compare this with camel_service_get_name(), which returns a built-in description of the type of service (IMAP, SMTP, etc.).
a valid UTF-8 string, or %NULL
Sets the password for service
. Use this function to cache the password
in memory after obtaining it through camel_session_get_password(). Some
SASL mechanisms use this when attempting to authenticate.
the password for service
Sets a property on an object.
the name of the property to set
the value
Sets the #GProxyResolver for service
. If an application needs to
override this, it should do so prior to calling functions on service
that may require a network connection.
a #GProxyResolver, or %NULL for the default
Associates a new #CamelSettings instance with the service.
The settings
instance must match the settings type defined in
#CamelServiceClass. If settings
is %NULL, a new #CamelSettings
instance of the appropriate type is created with all properties
set to defaults.
Sets the name of the file in which persistent property values for
object
are stored. The file is used by camel_object_state_write()
and camel_object_state_read() to save and restore object state.
path to a local file
Creates a #GTlsClientConnection wrapping base_stream,
which is
assumed to communicate with the server identified by service'
s
#CamelNetworkService:connectable.
This should typically be called after issuing a STARTTLS command to a server to initiate a Transport Layer Security handshake.
a #GIOStream
Read persistent object state from #CamelObject:state-filename.
Write persistent object state #CamelObject:state-filename.
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.
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.
Attempts to authenticate service
using mechanism
and, if necessary,
service'
s #CamelService:password property. The function makes only
ONE attempt at authentication and does not loop.
If the authentication attempt completed and the server accepted the credentials, the function returns #CAMEL_AUTHENTICATION_ACCEPTED.
If the authentication attempt completed but the server rejected the credentials, the function returns #CAMEL_AUTHENTICATION_REJECTED.
If the authentication attempt failed to complete due to a network
communication issue or some other mishap, the function sets error
and returns #CAMEL_AUTHENTICATION_ERROR.
Generally this function should only be called from a #CamelSession subclass in order to implement its own authentication loop.
a SASL mechanism name, or %NULL
optional #GCancellable object, or %NULL
Attempts to establish a network connection to the server described by
service,
using the preferred #CamelNetworkSettings:security-method to
secure the connection. If a connection cannot be established, or the
connection attempt is cancelled, the function sets error
and returns
%NULL.
optional #GCancellable object, or %NULL
Connects service
to a remote server using the information in its
#CamelService:settings instance.
If a connect operation is already in progress when this function is called, its results will be reflected in this connect operation.
optional #GCancellable object, or %NULL
Disconnect from the service. If clean
is %FALSE, it should not
try to do any synchronizing or other cleanup of the connection.
If a disconnect operation is already in progress when this function is called, its results will be reflected in this disconnect operation.
If any connect operations are in progress when this function is called, they will be cancelled.
whether or not to try to disconnect cleanly
optional #GCancellable object, or %NULL
Returns the default network port number for service
and the security
method method,
as defined in /etc/services. For example, the default
port for unencrypted IMAP or encrypted IMAP using STARTTLS is 143, but
the default port for IMAP over SSL is 993.
a #CamelNetworkSecurityMethod
This gets the name of the service in a "friendly" (suitable for
humans) form. If brief
is %TRUE, this should be a brief description
such as for use in the folder tree. If brief
is %FALSE, it should
be a more complete and mostly unambiguous description.
whether or not to use a briefer form
Returns the standard network service name for service
and the security
method method,
as defined in /etc/services. For example, the service
name for unencrypted IMAP or encrypted IMAP using STARTTLS is "imap",
but the service name for IMAP over SSL is "imaps".
a #CamelNetworkSecurityMethod
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable
is not %NULL,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. If cancellable
is not %NULL and
the object doesn't support cancellable initialization the error
%G_IO_ERROR_NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.
Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.
optional #GCancellable object, %NULL to ignore.
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.
Obtains a list of authentication types supported by service
.
Free the returned list with g_list_free().
optional #GCancellable object, or %NULL
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
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 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
The file in which to store persistent property values for this instance.