Top | ![]() |
![]() |
![]() |
![]() |
#define | CAMEL_IMAPX_SERVER_ERROR |
enum | CamelIMAPXServerError |
struct | CamelIMAPXUntaggedRespHandlerDesc |
gboolean (*CamelIMAPXUntaggedRespHandler) (,
CamelIMAPXServer *server,
GInputStream *input_stream,
GCancellable *cancellable);
GError **error
CamelIMAPXServer * camel_imapx_server_new (struct _CamelIMAPXStore *store
);
struct_CamelIMAPXStore * camel_imapx_server_ref_store ();
CamelIMAPXServer *is
struct_CamelIMAPXSettings * camel_imapx_server_ref_settings ();
CamelIMAPXServer *is
GInputStream * camel_imapx_server_ref_input_stream ();
CamelIMAPXServer *is
Returns the is
, which is owned by either a
NULL
The returned g_object_unref()
Since: 3.12
GOutputStream * camel_imapx_server_ref_output_stream ();
CamelIMAPXServer *is
Returns the is
, which is owned by either a
NULL
The returned g_object_unref()
Since: 3.12
CamelIMAPXMailbox *
camel_imapx_server_ref_selected (CamelIMAPXServer *is
);
Returns the CamelIMAPXMailbox representing the currently selected
mailbox (or mailbox being selected if a SELECT
command is in progress) on the IMAP server, or NULL
The returned CamelIMAPXMailbox is reference for thread-safety and
should be unreferenced with g_object_unref()
Since: 3.12
CamelIMAPXMailbox *
camel_imapx_server_ref_pending_or_selected
(CamelIMAPXServer *is
);
const struct_capability_info * camel_imapx_server_get_capability_info ();
CamelIMAPXServer *is
gboolean camel_imapx_server_have_capability (,
CamelIMAPXServer *is);
guint32 capability
gboolean camel_imapx_server_lack_capability (,
CamelIMAPXServer *is);
guint32 capability
void camel_imapx_server_set_tagprefix (,
CamelIMAPXServer *is);
gchar tagprefix
CamelIMAPXCommand * camel_imapx_server_ref_current_command ();
CamelIMAPXServer *is
gboolean camel_imapx_server_connect_sync (,
CamelIMAPXServer *is,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_disconnect_sync (,
CamelIMAPXServer *is,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_is_connected ();
CamelIMAPXServer *imapx_server
CamelAuthenticationResult camel_imapx_server_authenticate_sync (,
CamelIMAPXServer *isconst
,gchar *mechanism,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_query_auth_types_sync (,
CamelIMAPXServer *is,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_mailbox_selected (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
);
gboolean camel_imapx_server_ensure_selected_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_process_command_sync (,
CamelIMAPXServer *is,
CamelIMAPXCommand *icconst
,gchar *error_prefix,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_list_sync (,
CamelIMAPXServer *isconst
,gchar *patternCamelStoreGetFolderInfoFlags flags
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_refresh_info_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_sync_changes_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
gboolean can_influence_flags,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_expunge_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_noop_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
CamelStream * camel_imapx_server_get_message_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
CamelFolderSummary *summary,
CamelDataCache *message_cacheconst
,gchar *message_uid,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_copy_message_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,CamelIMAPXMailbox *destination
,,
GPtrArray *uids,
gboolean delete_originals,
gboolean remove_deleted_flags,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_append_message_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
CamelFolderSummary *summary,
CamelDataCache *message_cache,
CamelMimeMessage *messageconst
,CamelMessageInfo *mi,
gchar **append_uid,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_sync_message_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
CamelFolderSummary *summary,
CamelDataCache *message_cacheconst
,gchar *message_uid,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_create_mailbox_sync (,
CamelIMAPXServer *isconst
,gchar *mailbox_name,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_delete_mailbox_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_rename_mailbox_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,const
,gchar *new_mailbox_name,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_subscribe_mailbox_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_unsubscribe_mailbox_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_update_quota_info_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
GPtrArray * camel_imapx_server_uid_search_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,const
,gchar *criteria_prefixconst
,gchar *search_keyconst
,gchar * const *words,
GCancellable *cancellable);
GError **error
CamelIMAPXMailbox *
camel_imapx_server_ref_idle_mailbox (CamelIMAPXServer *is
);
gboolean camel_imapx_server_schedule_idle_sync (,
CamelIMAPXServer *isCamelIMAPXMailbox *mailbox
,,
GCancellable *cancellable);
GError **error
gboolean camel_imapx_server_stop_idle_sync (,
CamelIMAPXServer *is,
GCancellable *cancellable);
GError **error
const CamelIMAPXUntaggedRespHandlerDesc * camel_imapx_server_register_untagged_handler (,
CamelIMAPXServer *isconst
,gchar *untagged_responseconst CamelIMAPXUntaggedRespHandlerDesc *desc
);
Register a new handler function for IMAP untagged responses. Pass in a NULL descriptor to delete an existing handler (the untagged response will remain known, but will no longer be acted upon if the handler is deleted). The return value is intended to be used in cases where e.g. an extension to existing handler code is implemented with just some new code to be run before or after the original handler code
is |
a |
|
untagged_response |
a string representation of the IMAP untagged response code. Must be all-uppercase with underscores allowed (see RFC 3501) |
|
desc |
a CamelIMAPXUntaggedRespHandlerDesc handler description
structure. The descriptor structure is expected to
remain stable over the lifetime of the |
the CamelIMAPXUntaggedRespHandlerDesc previously registered for this untagged response, if any, NULL otherwise.
Since: 3.6
struct CamelIMAPXUntaggedRespHandlerDesc { const gchar *untagged_response; const CamelIMAPXUntaggedRespHandler handler; const gchar *next_response; gboolean skip_stream_when_done; };
IMAP untagged response handler function descriptor. Use in conjunction
with camel_imapx_server_register_untagged_handler()
to register a new
handler function for a given untagged response code
a string representation of the IMAP untagged response code. Must be all-uppercase with underscores allowed (see RFC 3501) |
||
const CamelIMAPXUntaggedRespHandler |
an untagged response handler function for |
|
the IMAP untagged code to call a registered
handler for directly after successfully
running |
||
whether or not to skip the current IMAP
untagged response in the |
Since: 3.6