## CamelIMAPXStatusResponse

CamelIMAPXStatusResponse — Stores an IMAP STATUS respose

## Synopsis

    #include <camel/camel.h>

    struct              CamelIMAPXStatusResponse;
    CamelIMAPXStatusResponse * camel_imapx_status_response_new
                                                            (CamelIMAPXStream *stream,
                                                             gchar inbox_separator,
                                                             GCancellable *cancellable,
                                                             GError **error);
    const gchar *       camel_imapx_status_response_get_mailbox_name
                                                            (CamelIMAPXStatusResponse *response);
    guint32             camel_imapx_status_response_get_messages
                                                            (CamelIMAPXStatusResponse *response);
    guint32             camel_imapx_status_response_get_recent
                                                            (CamelIMAPXStatusResponse *response);
    guint32             camel_imapx_status_response_get_unseen
                                                            (CamelIMAPXStatusResponse *response);
    guint32             camel_imapx_status_response_get_uidnext
                                                            (CamelIMAPXStatusResponse *response);
    guint32             camel_imapx_status_response_get_uidvalidity
                                                            (CamelIMAPXStatusResponse *response);
    guint64             camel_imapx_status_response_get_highestmodseq
                                                            (CamelIMAPXStatusResponse *response);

## Object Hierarchy

      GObject
       +----CamelIMAPXStatusResponse

## Description

CamelIMAPXStatusResponse encapsulates an IMAP STATUS response, which describes the current status of a mailbox in terms of various message counts and change tracking indicators.

## Details

### struct CamelIMAPXStatusResponse

    struct CamelIMAPXStatusResponse;

Contains only private data that should be read and manipulated using the functions below.

Since 3.10

### camel_imapx_status_response_new ()

    CamelIMAPXStatusResponse * camel_imapx_status_response_new
                                                            (CamelIMAPXStream *stream,
                                                             gchar inbox_separator,
                                                             GCancellable *cancellable,
                                                             GError **error);

Attempts to parse an IMAP STATUS response from `stream` and, if successful, stores the response data in a new CamelIMAPXStatusResponse. If an error occurs, the function sets `error` and returns `NULL`.

`stream` : | a CamelIMAPXStream
`inbox_separator` : | the separator character for INBOX
`cancellable` : | a GCancellable
`error` : | return location for a GError, or `NULL`
Returns : | a CamelIMAPXStatusResponse, or `NULL`

Since 3.10

### camel_imapx_status_response_get_mailbox_name ()

    const gchar *       camel_imapx_status_response_get_mailbox_name
                                                            (CamelIMAPXStatusResponse *response);

Returns the mailbox name for `response`.

`response` : | a CamelIMAPXStatusResponse
Returns : | the mailbox name

Since 3.10

### camel_imapx_status_response_get_messages ()

    guint32             camel_imapx_status_response_get_messages
                                                            (CamelIMAPXStatusResponse *response);

Returns the number of messages in the mailbox.

`response` : | a CamelIMAPXStatusResponse
Returns : | the "MESSAGES" status value

Since 3.10

### camel_imapx_status_response_get_recent ()

    guint32             camel_imapx_status_response_get_recent
                                                            (CamelIMAPXStatusResponse *response);

Returns the number of messages with the \Recent flag set.

`response` : | a CamelIMAPXStatusResponse
Returns : | the "RECENT" status valud

Since 3.10

### camel_imapx_status_response_get_unseen ()

    guint32             camel_imapx_status_response_get_unseen
                                                            (CamelIMAPXStatusResponse *response);

Returns the number of messages which do no have the \Seen flag set.

`response` : | a CamelIMAPXStatusResponse
Returns : | the "UNSEEN" status value

Since 3.10

### camel_imapx_status_response_get_uidnext ()

    guint32             camel_imapx_status_response_get_uidnext
                                                            (CamelIMAPXStatusResponse *response);

Return the next unique identifier value of the mailbox.

`response` : | a CamelIMAPXStatusResponse
Returns : | the "UIDNEXT" status value

Since 3.10

### camel_imapx_status_response_get_uidvalidity ()

    guint32             camel_imapx_status_response_get_uidvalidity
                                                            (CamelIMAPXStatusResponse *response);

Returns the unique identifier validity value of the mailbox.

`response` : | a CamelIMAPXStatusResponse
Returns : | the "UIDVALIDITY" status value

Since 3.10

### camel_imapx_status_response_get_highestmodseq ()

    guint64             camel_imapx_status_response_get_highestmodseq
                                                            (CamelIMAPXStatusResponse *response);

Returns the highest mod-sequence value of all messages in the mailbox, or zero if the server does not support the persistent storage of mod-sequences for the mailbox.

`response` : | a CamelIMAPXStatusResponse
Returns : | the "HIGHESTMODSEQ" status value

Since 3.10