![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
struct CamelIMAPXServer; 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
); CamelIMAPXStream * camel_imapx_server_ref_stream (CamelIMAPXServer *is
); gboolean camel_imapx_server_connect (CamelIMAPXServer *is
,GCancellable *cancellable
,GError **error
); CamelAuthenticationResult camel_imapx_server_authenticate (CamelIMAPXServer *is
,const gchar *mechanism
,GCancellable *cancellable
,GError **error
); GPtrArray * camel_imapx_server_list (CamelIMAPXServer *is
,const gchar *pattern
,CamelStoreGetFolderInfoFlags flags
,const gchar *ext
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_refresh_info (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_sync_changes (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_expunge (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_fetch_messages (CamelIMAPXServer *is
,CamelFolder *folder
,CamelFetchType type
,gint limit
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_noop (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
); CamelStream * camel_imapx_server_get_message (CamelIMAPXServer *is
,CamelFolder *folder
,const gchar *uid
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_copy_message (CamelIMAPXServer *is
,CamelFolder *source
,CamelFolder *dest
,GPtrArray *uids
,gboolean delete_originals
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_append_message (CamelIMAPXServer *is
,CamelFolder *folder
,CamelMimeMessage *message
,const CamelMessageInfo *mi
,gchar **append_uid
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_sync_message (CamelIMAPXServer *is
,CamelFolder *folder
,const gchar *uid
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_manage_subscription (CamelIMAPXServer *is
,const gchar *folder_name
,gboolean subscribe
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_create_folder (CamelIMAPXServer *is
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_delete_folder (CamelIMAPXServer *is
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_rename_folder (CamelIMAPXServer *is
,const gchar *old_name
,const gchar *new_name
,GCancellable *cancellable
,GError **error
); gboolean camel_imapx_server_update_quota_info (CamelIMAPXServer *is
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
); GPtrArray * camel_imapx_server_uid_search (CamelIMAPXServer *is
,CamelFolder *folder
,const gchar *criteria
,GCancellable *cancellable
,GError **error
); struct CamelIMAPXUntaggedRespHandlerDesc; const CamelIMAPXUntaggedRespHandlerDesc * camel_imapx_server_register_untagged_handler (CamelIMAPXServer *is
,const gchar *untagged_response
,const CamelIMAPXUntaggedRespHandlerDesc *desc
);
"store" CamelIMAPXStore* : Read / Write / Construct Only "stream" CamelIMAPXStream* : Read
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
);
CamelIMAPXStream * camel_imapx_server_ref_stream (CamelIMAPXServer *is
);
gboolean camel_imapx_server_connect (CamelIMAPXServer *is
,GCancellable *cancellable
,GError **error
);
CamelAuthenticationResult camel_imapx_server_authenticate (CamelIMAPXServer *is
,const gchar *mechanism
,GCancellable *cancellable
,GError **error
);
GPtrArray * camel_imapx_server_list (CamelIMAPXServer *is
,const gchar *pattern
,CamelStoreGetFolderInfoFlags flags
,const gchar *ext
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_refresh_info (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_sync_changes (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_expunge (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_fetch_messages (CamelIMAPXServer *is
,CamelFolder *folder
,CamelFetchType type
,gint limit
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_noop (CamelIMAPXServer *is
,CamelFolder *folder
,GCancellable *cancellable
,GError **error
);
CamelStream * camel_imapx_server_get_message (CamelIMAPXServer *is
,CamelFolder *folder
,const gchar *uid
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_copy_message (CamelIMAPXServer *is
,CamelFolder *source
,CamelFolder *dest
,GPtrArray *uids
,gboolean delete_originals
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_append_message (CamelIMAPXServer *is
,CamelFolder *folder
,CamelMimeMessage *message
,const CamelMessageInfo *mi
,gchar **append_uid
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_sync_message (CamelIMAPXServer *is
,CamelFolder *folder
,const gchar *uid
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_manage_subscription (CamelIMAPXServer *is
,const gchar *folder_name
,gboolean subscribe
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_create_folder (CamelIMAPXServer *is
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_delete_folder (CamelIMAPXServer *is
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_rename_folder (CamelIMAPXServer *is
,const gchar *old_name
,const gchar *new_name
,GCancellable *cancellable
,GError **error
);
gboolean camel_imapx_server_update_quota_info (CamelIMAPXServer *is
,const gchar *folder_name
,GCancellable *cancellable
,GError **error
);
GPtrArray * camel_imapx_server_uid_search (CamelIMAPXServer *is
,CamelFolder *folder
,const gchar *criteria
,GCancellable *cancellable
,GError **error
);
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) | |
an untagged response handler function for CamelIMAPXServer | |
the IMAP untagged code to call a registered
handler for directly after successfully
running handler . If not NULL, skip_stream_when_done
for the current handler has no effect |
|
whether or not to skip the current IMAP untagged response in the CamelIMAPXStream. Set to TRUE if your handler does not eat the stream up to the next response token |
Since 3.6
const CamelIMAPXUntaggedRespHandlerDesc * camel_imapx_server_register_untagged_handler (CamelIMAPXServer *is
,const gchar *untagged_response
,const 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
|
a CamelIMAPXServer instance |
|
a string representation of the IMAP untagged response code. Must be all-uppercase with underscores allowed (see RFC 3501) |
|
a CamelIMAPXUntaggedRespHandlerDesc handler description structure. The descriptor structure is expected to remain stable over the lifetime of the CamelIMAPXServer instance it was registered with. It is the responsibility of the caller to ensure this |
Returns : |
the CamelIMAPXUntaggedRespHandlerDesc previously registered for this untagged response, if any, NULL otherwise. |
Since 3.6
"store"
property"store" CamelIMAPXStore* : Read / Write / Construct Only
IMAPX store for this server.