camel-imapx-job: Camel Reference Manual

## camel-imapx-job camel-imapx-job |

## Functions

const gchar * | (*CamelIMAPXJobGetKindNameFunc) ()
const gchar * | camel_imapx_job_get_kind_name ()
void | camel_imapx_job_register_get_kind_name_func ()
void | camel_imapx_job_unregister_get_kind_name_func ()
gboolean | (*CamelIMAPXJobRunSyncFunc) ()
gboolean | (*CamelIMAPXJobMatchesFunc) ()
void | (*CamelIMAPXJobCopyResultFunc) ()
CamelIMAPXJob * | camel_imapx_job_new ()
CamelIMAPXJob * | camel_imapx_job_ref ()
void | camel_imapx_job_unref ()
guint32 | camel_imapx_job_get_kind ()
CamelIMAPXMailbox * | camel_imapx_job_get_mailbox ()
gpointer | camel_imapx_job_get_user_data ()
void | camel_imapx_job_set_user_data ()
gboolean | camel_imapx_job_was_cancelled ()
void | camel_imapx_job_set_result ()
gboolean | camel_imapx_job_copy_result ()
gboolean | camel_imapx_job_take_result_data ()
gboolean | camel_imapx_job_matches ()
gboolean | camel_imapx_job_run_sync ()
void | camel_imapx_job_done ()
void | camel_imapx_job_abort ()
void | camel_imapx_job_wait_sync ()

## Types and Values

enum | CamelIMAPXJobKind
| CamelIMAPXJob

## Description

## Functions

### CamelIMAPXJobGetKindNameFunc ()

    const gchar *
    (*CamelIMAPXJobGetKindNameFunc) (guint32 job_kind);

### camel_imapx_job_get_kind_name ()

    const gchar *
    camel_imapx_job_get_kind_name (guint32 job_kind);

### camel_imapx_job_register_get_kind_name_func ()

    void
    camel_imapx_job_register_get_kind_name_func
                                   (CamelIMAPXJobGetKindNameFunc get_kind_name);

### camel_imapx_job_unregister_get_kind_name_func ()

    void
    camel_imapx_job_unregister_get_kind_name_func
                                   (CamelIMAPXJobGetKindNameFunc get_kind_name);

### CamelIMAPXJobRunSyncFunc ()

    gboolean
    (*CamelIMAPXJobRunSyncFunc) (CamelIMAPXJob *job,
                                 CamelIMAPXServer *server,
                                 GCancellable *cancellable,
                                 GError **error);

### CamelIMAPXJobMatchesFunc ()

    gboolean
    (*CamelIMAPXJobMatchesFunc) (CamelIMAPXJob *job,
                                 CamelIMAPXJob *other_job);

### CamelIMAPXJobCopyResultFunc ()

    void
    (*CamelIMAPXJobCopyResultFunc) (CamelIMAPXJob *job,
                                    gconstpointer set_result,
                                    gpointer *out_result);

### camel_imapx_job_new ()

    CamelIMAPXJob *
    camel_imapx_job_new (guint32 job_kind,
                         CamelIMAPXMailbox *mailbox,
                         CamelIMAPXJobRunSyncFunc run_sync,
                         CamelIMAPXJobMatchesFunc matches,
                         CamelIMAPXJobCopyResultFunc copy_result);

### camel_imapx_job_ref ()

    CamelIMAPXJob *
    camel_imapx_job_ref (CamelIMAPXJob *job);

### camel_imapx_job_unref ()

    void
    camel_imapx_job_unref (CamelIMAPXJob *job);

### camel_imapx_job_get_kind ()

    guint32
    camel_imapx_job_get_kind (CamelIMAPXJob *job);

### camel_imapx_job_get_mailbox ()

    CamelIMAPXMailbox *
    camel_imapx_job_get_mailbox (CamelIMAPXJob *job);

### camel_imapx_job_get_user_data ()

    gpointer
    camel_imapx_job_get_user_data (CamelIMAPXJob *job);

### camel_imapx_job_set_user_data ()

    void
    camel_imapx_job_set_user_data (CamelIMAPXJob *job,
                                   gpointer user_data,
                                   GDestroyNotify destroy_user_data);

### camel_imapx_job_was_cancelled ()

    gboolean
    camel_imapx_job_was_cancelled (CamelIMAPXJob *job);

### camel_imapx_job_set_result ()

    void
    camel_imapx_job_set_result (CamelIMAPXJob *job,
                                gboolean success,
                                gpointer result,
                                const GError *error,
                                GDestroyNotify destroy_result);

### camel_imapx_job_copy_result ()

    gboolean
    camel_imapx_job_copy_result (CamelIMAPXJob *job,
                                 gboolean *out_success,
                                 gpointer *out_result,
                                 GError **out_error,
                                 GDestroyNotify *out_destroy_result);

### camel_imapx_job_take_result_data ()

    gboolean
    camel_imapx_job_take_result_data (CamelIMAPXJob *job,
                                      gpointer *out_result);

### camel_imapx_job_matches ()

    gboolean
    camel_imapx_job_matches (CamelIMAPXJob *job,
                             CamelIMAPXJob *other_job);

### camel_imapx_job_run_sync ()

    gboolean
    camel_imapx_job_run_sync (CamelIMAPXJob *job,
                              CamelIMAPXServer *server,
                              GCancellable *cancellable,
                              GError **error);

### camel_imapx_job_done ()

    void
    camel_imapx_job_done (CamelIMAPXJob *job);

### camel_imapx_job_abort ()

    void
    camel_imapx_job_abort (CamelIMAPXJob *job);

### camel_imapx_job_wait_sync ()

    void
    camel_imapx_job_wait_sync (CamelIMAPXJob *job,
                               GCancellable *cancellable);

## Types and Values

### enum CamelIMAPXJobKind

#### Members

CAMEL_IMAPX_JOB_UNKNOWN |  |
CAMEL_IMAPX_JOB_CAPABILITY |  |
CAMEL_IMAPX_JOB_STARTTLS |  |
CAMEL_IMAPX_JOB_AUTHENTICATE |  |
CAMEL_IMAPX_JOB_LOGIN |  |
CAMEL_IMAPX_JOB_ID |  |
CAMEL_IMAPX_JOB_NAMESPACE |  |
CAMEL_IMAPX_JOB_SELECT |  |
CAMEL_IMAPX_JOB_STATUS |  |
CAMEL_IMAPX_JOB_ENABLE |  |
CAMEL_IMAPX_JOB_NOTIFY |  |
CAMEL_IMAPX_JOB_GET_MESSAGE |  |
CAMEL_IMAPX_JOB_SYNC_MESSAGE |  |
CAMEL_IMAPX_JOB_APPEND_MESSAGE |  |
CAMEL_IMAPX_JOB_COPY_MESSAGE |  |
CAMEL_IMAPX_JOB_MOVE_MESSAGE |  |
CAMEL_IMAPX_JOB_FETCH_NEW_MESSAGES |  |
CAMEL_IMAPX_JOB_REFRESH_INFO |  |
CAMEL_IMAPX_JOB_SYNC_CHANGES |  |
CAMEL_IMAPX_JOB_EXPUNGE |  |
CAMEL_IMAPX_JOB_NOOP |  |
CAMEL_IMAPX_JOB_IDLE |  |
CAMEL_IMAPX_JOB_DONE |  |
CAMEL_IMAPX_JOB_LIST |  |
CAMEL_IMAPX_JOB_LSUB |  |
CAMEL_IMAPX_JOB_CREATE_MAILBOX |  |
CAMEL_IMAPX_JOB_DELETE_MAILBOX |  |
CAMEL_IMAPX_JOB_RENAME_MAILBOX |  |
CAMEL_IMAPX_JOB_SUBSCRIBE_MAILBOX |  |
CAMEL_IMAPX_JOB_UNSUBSCRIBE_MAILBOX |  |
CAMEL_IMAPX_JOB_UPDATE_QUOTA_INFO |  |
CAMEL_IMAPX_JOB_UID_SEARCH |  |
CAMEL_IMAPX_JOB_LAST |  |

### CamelIMAPXJob

    typedef struct _CamelIMAPXJob CamelIMAPXJob;