![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
CamelSubscribable; gboolean camel_subscribable_folder_is_subscribed (CamelSubscribable *subscribable
,const gchar *folder_name
); gboolean camel_subscribable_subscribe_folder_sync (CamelSubscribable *subscribable
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
); void camel_subscribable_subscribe_folder (CamelSubscribable *subscribable
,const gchar *folder_name
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean camel_subscribable_subscribe_folder_finish (CamelSubscribable *subscribable
,GAsyncResult *result
,GError **error
); gboolean camel_subscribable_unsubscribe_folder_sync (CamelSubscribable *subscribable
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
); void camel_subscribable_unsubscribe_folder (CamelSubscribable *subscribable
,const gchar *folder_name
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean camel_subscribable_unsubscribe_folder_finish (CamelSubscribable *subscribable
,GAsyncResult *result
,GError **error
); void camel_subscribable_folder_subscribed (CamelSubscribable *subscribable
,CamelFolderInfo *folder_info
); void camel_subscribable_folder_unsubscribed (CamelSubscribable *subscribable
,CamelFolderInfo *folder_info
);
gboolean camel_subscribable_folder_is_subscribed (CamelSubscribable *subscribable
,const gchar *folder_name
);
Find out if a folder has been subscribed to.
|
a CamelSubscribable |
|
full path of the folder |
Returns : |
TRUE if the folder has been subscribed to or FALSE otherwise |
Since 3.2
gboolean camel_subscribable_subscribe_folder_sync (CamelSubscribable *subscribable
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
);
Subscribes to the folder described by folder_name
.
|
a CamelSubscribable |
|
full path of the folder |
|
optional GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
TRUE on success, FALSE on error |
Since 3.2
void camel_subscribable_subscribe_folder (CamelSubscribable *subscribable
,const gchar *folder_name
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously subscribes to the folder described by folder_name
.
When the operation is finished, callback
will be called. You can then
call camel_subscribable_subscribe_folder_finish()
to get the result of
the operation.
|
a CamelSubscribable |
|
full path of the folder |
|
the I/O priority of the request |
|
optional GCancellable object, or NULL
|
|
a GAsyncReadyCallback to call when the request is satisfied |
|
data to pass to the callback function |
Since 3.2
gboolean camel_subscribable_subscribe_folder_finish (CamelSubscribable *subscribable
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_subscribable_subscribe_folder()
.
|
a CamelSubscribable |
|
a GAsyncResult |
|
return location for a GError, or NULL
|
Returns : |
TRUE on success, FALSE on error |
Since 3.2
gboolean camel_subscribable_unsubscribe_folder_sync (CamelSubscribable *subscribable
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
);
Unsubscribes from the folder described by folder_name
.
|
a CamelSubscribable |
|
full path of the folder |
|
optional GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
TRUE on success, FALSE on error |
Since 3.2
void camel_subscribable_unsubscribe_folder (CamelSubscribable *subscribable
,const gchar *folder_name
,gint io_priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously unsubscribes from the folder described by folder_name
.
When the operation is finished, callback
will be called. You can then
call camel_subscribable_unsubscribe_folder_finish()
to get the result of
the operation.
|
a CamelSubscribable |
|
full path of the folder |
|
the I/O priority of the request |
|
optional GCancellable object, or NULL
|
|
a GAsyncReadyCallback to call when the request is satisfied |
|
data to pass to the callback function |
Since 3.2
gboolean camel_subscribable_unsubscribe_folder_finish (CamelSubscribable *subscribable
,GAsyncResult *result
,GError **error
);
Finishes the operation started with camel_subscribable_unsubscribe_folder()
.
|
a CamelSubscribable |
|
a GAsyncResult |
|
return location for a GError, or NULL
|
Returns : |
TRUE on success, FALSE on error |
Since 3.2
void camel_subscribable_folder_subscribed (CamelSubscribable *subscribable
,CamelFolderInfo *folder_info
);
Emits the "folder-subscribed" signal from an idle source on the main loop. The idle source's priority is G_PRIORITY_DEFAULT_IDLE.
This function is only intended for Camel providers.
|
a CamelSubscribable |
|
information about the subscribed folder |
Since 3.2
void camel_subscribable_folder_unsubscribed (CamelSubscribable *subscribable
,CamelFolderInfo *folder_info
);
Emits the "folder-unsubscribed" signal from an idle source on the main loop. The idle source's priority is G_PRIORITY_DEFAULT_IDLE.
This function is only intended for Camel providers.
|
a CamelSubscribable |
|
information about the unsubscribed folder |
Since 3.2