EZimbraConnection

EZimbraConnection

Synopsis




                    EZimbraConnection;
typedef             EZimbraConnectionStatus             ();
#define             E_ZIMBRA_CURSOR_POSITION_CURRENT
#define             E_ZIMBRA_CURSOR_POSITION_START
#define             E_ZIMBRA_CURSOR_POSITION_END
EZimbraConnection*  e_zimbra_connection_new             (ESource *source,
                                                         const gchar *username,
                                                         const gchar *password);
gboolean            e_zimbra_connection_register_client (EZimbraConnection *cnc,
                                                         const gchar *folder_id,
                                                         gpointer handle,
                                                         EZimbraConnectionClientSyncFunc sync_func);
void                e_zimbra_connection_unregister_client
                                                        (EZimbraConnection *cnc,
                                                         const gchar *folder_id);
gboolean            e_zimbra_connection_sync            (EZimbraConnection *cnc);
const gchar*        e_zimbra_connection_get_error_message
                                                        (EZimbraConnectionStatus status);
EZimbraConnectionStatus e_zimbra_connection_logout      (EZimbraConnection *cnc);
EZimbraFolder*      e_zimbra_connection_peek_folder_by_id
                                                        (EZimbraConnection *cnc,
                                                         const gchar *id);
EZimbraConnectionStatus e_zimbra_connection_peek_folders_by_type
                                                        (EZimbraConnection *cnc,
                                                         EZimbraFolderType type,
                                                         GList **folders);
void                e_zimbra_connection_free_folders    (GList *folders);
gchar*              e_zimbra_connection_get_folder_id   (EZimbraConnection *cnc,
                                                         const gchar *name);
const gchar*        e_zimbra_connection_get_uri         (EZimbraConnection *cnc);
const gchar*        e_zimbra_connection_get_session_id  (EZimbraConnection *cnc);
const gchar*        e_zimbra_connection_get_user_name   (EZimbraConnection *cnc);
const gchar*        e_zimbra_connection_get_user_email  (EZimbraConnection *cnc);
const gchar*        e_zimbra_connection_get_user_uuid   (EZimbraConnection *cnc);
const gchar*        e_zimbra_connection_get_version     (EZimbraConnection *cnc);
time_t              e_zimbra_connection_get_date_from_string
                                                        (const gchar *dtstring);
gchar*              e_zimbra_connection_format_date_string
                                                        (const gchar *dtstring);
EZimbraConnectionStatus e_zimbra_connection_get_item    (EZimbraConnection *cnc,
                                                         EZimbraItemType type,
                                                         const gchar *zid,
                                                         EZimbraItem **item);
EZimbraConnectionStatus e_zimbra_connection_get_items   (EZimbraConnection *cnc,
                                                         EZimbraItemType type,
                                                         GPtrArray *ids,
                                                         GPtrArray **items);
EZimbraConnectionStatus e_zimbra_connection_create_item (EZimbraConnection *cnc,
                                                         EZimbraItem *item,
                                                         gchar **id,
                                                         gchar **rev);
EZimbraConnectionStatus e_zimbra_connection_modify_item (EZimbraConnection *cnc,
                                                         EZimbraItem *item,
                                                         const gchar *id,
                                                         gchar **rev);
EZimbraConnectionStatus e_zimbra_connection_remove_item (EZimbraConnection *cnc,
                                                         const gchar *container,
                                                         EZimbraItemType type,
                                                         const gchar *id);
EZimbraConnectionStatus e_zimbra_connection_remove_items
                                                        (EZimbraConnection *cnc,
                                                         const gchar *container,
                                                         EZimbraItemType type,
                                                         GPtrArray *ids);
gchar*              e_zimbra_connection_uid_to_folder_id
                                                        (EZimbraConnection *cnc,
                                                         const gchar *uid);
EZimbraConnectionStatus e_zimbra_connection_get_folders_by_type
                                                        (EZimbraConnection *cnc,
                                                         EZimbraFolderType type,
                                                         GList **list);
EZimbraConnectionStatus e_zimbra_connection_create_folder
                                                        (EZimbraConnection *cnc,
                                                         const gchar *parent_name,
                                                         ESource *source,
                                                         EZimbraFolderType folder_type,
                                                         gchar **folder_id,
                                                         gchar **rev);
EZimbraConnectionStatus e_zimbra_connection_rename_folder
                                                        (EZimbraConnection *cnc,
                                                         const gchar *folder_id,
                                                         const gchar *new_name,
                                                         gchar **rev);
EZimbraConnectionStatus e_zimbra_connection_delete_folder
                                                        (EZimbraConnection *cnc,
                                                         const gchar *folder_id);
EZimbraConnectionStatus e_zimbra_connection_get_message (EZimbraConnection *cnc,
                                                         const gchar *inv_id,
                                                         gchar **message);
EZimbraConnectionStatus e_zimbra_connection_get_page    (EZimbraConnection *cnc,
                                                         const gchar *url,
                                                         gchar **page);
const gchar*        e_zimbra_connection_get_hostname    (EZimbraConnection *cnc);
gboolean            e_zimbra_connection_use_ssl         (EZimbraConnection *cnc);
gint                e_zimbra_connection_get_port        (EZimbraConnection *cnc);
gboolean            e_zimbra_connection_zombie          (EZimbraConnection *cnc);

Object Hierarchy


  GObject
   +----EZimbraConnection

Description

Details

EZimbraConnection

typedef struct _EZimbraConnection EZimbraConnection;

EZimbraConnectionStatus ()

typedef             EZimbraConnectionStatus             ();

Returns :

E_ZIMBRA_CURSOR_POSITION_CURRENT

#define E_ZIMBRA_CURSOR_POSITION_CURRENT        "current"

E_ZIMBRA_CURSOR_POSITION_START

#define E_ZIMBRA_CURSOR_POSITION_START          "start"

E_ZIMBRA_CURSOR_POSITION_END

#define E_ZIMBRA_CURSOR_POSITION_END            "end"

e_zimbra_connection_new ()

EZimbraConnection*  e_zimbra_connection_new             (ESource *source,
                                                         const gchar *username,
                                                         const gchar *password);

source :

username :

password :

Returns :

e_zimbra_connection_register_client ()

gboolean            e_zimbra_connection_register_client (EZimbraConnection *cnc,
                                                         const gchar *folder_id,
                                                         gpointer handle,
                                                         EZimbraConnectionClientSyncFunc sync_func);

cnc :

folder_id :

handle :

sync_func :

Returns :

e_zimbra_connection_unregister_client ()

void                e_zimbra_connection_unregister_client
                                                        (EZimbraConnection *cnc,
                                                         const gchar *folder_id);

cnc :

folder_id :

e_zimbra_connection_sync ()

gboolean            e_zimbra_connection_sync            (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_error_message ()

const gchar*        e_zimbra_connection_get_error_message
                                                        (EZimbraConnectionStatus status);

status :

Returns :

e_zimbra_connection_logout ()

EZimbraConnectionStatus e_zimbra_connection_logout      (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_peek_folder_by_id ()

EZimbraFolder*      e_zimbra_connection_peek_folder_by_id
                                                        (EZimbraConnection *cnc,
                                                         const gchar *id);

cnc :

id :

Returns :

e_zimbra_connection_peek_folders_by_type ()

EZimbraConnectionStatus e_zimbra_connection_peek_folders_by_type
                                                        (EZimbraConnection *cnc,
                                                         EZimbraFolderType type,
                                                         GList **folders);

cnc :

type :

folders :

Returns :

e_zimbra_connection_free_folders ()

void                e_zimbra_connection_free_folders    (GList *folders);

folders :

e_zimbra_connection_get_folder_id ()

gchar*              e_zimbra_connection_get_folder_id   (EZimbraConnection *cnc,
                                                         const gchar *name);

cnc :

name :

Returns :

e_zimbra_connection_get_uri ()

const gchar*        e_zimbra_connection_get_uri         (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_session_id ()

const gchar*        e_zimbra_connection_get_session_id  (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_user_name ()

const gchar*        e_zimbra_connection_get_user_name   (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_user_email ()

const gchar*        e_zimbra_connection_get_user_email  (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_user_uuid ()

const gchar*        e_zimbra_connection_get_user_uuid   (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_version ()

const gchar*        e_zimbra_connection_get_version     (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_date_from_string ()

time_t              e_zimbra_connection_get_date_from_string
                                                        (const gchar *dtstring);

dtstring :

Returns :

e_zimbra_connection_format_date_string ()

gchar*              e_zimbra_connection_format_date_string
                                                        (const gchar *dtstring);

dtstring :

Returns :

e_zimbra_connection_get_item ()

EZimbraConnectionStatus e_zimbra_connection_get_item    (EZimbraConnection *cnc,
                                                         EZimbraItemType type,
                                                         const gchar *zid,
                                                         EZimbraItem **item);

cnc :

type :

zid :

item :

Returns :

e_zimbra_connection_get_items ()

EZimbraConnectionStatus e_zimbra_connection_get_items   (EZimbraConnection *cnc,
                                                         EZimbraItemType type,
                                                         GPtrArray *ids,
                                                         GPtrArray **items);

cnc :

type :

ids :

items :

Returns :

e_zimbra_connection_create_item ()

EZimbraConnectionStatus e_zimbra_connection_create_item (EZimbraConnection *cnc,
                                                         EZimbraItem *item,
                                                         gchar **id,
                                                         gchar **rev);

cnc :

item :

id :

rev :

Returns :

e_zimbra_connection_modify_item ()

EZimbraConnectionStatus e_zimbra_connection_modify_item (EZimbraConnection *cnc,
                                                         EZimbraItem *item,
                                                         const gchar *id,
                                                         gchar **rev);

cnc :

item :

id :

rev :

Returns :

e_zimbra_connection_remove_item ()

EZimbraConnectionStatus e_zimbra_connection_remove_item (EZimbraConnection *cnc,
                                                         const gchar *container,
                                                         EZimbraItemType type,
                                                         const gchar *id);

cnc :

container :

type :

id :

Returns :

e_zimbra_connection_remove_items ()

EZimbraConnectionStatus e_zimbra_connection_remove_items
                                                        (EZimbraConnection *cnc,
                                                         const gchar *container,
                                                         EZimbraItemType type,
                                                         GPtrArray *ids);

cnc :

container :

type :

ids :

Returns :

e_zimbra_connection_uid_to_folder_id ()

gchar*              e_zimbra_connection_uid_to_folder_id
                                                        (EZimbraConnection *cnc,
                                                         const gchar *uid);

cnc :

uid :

Returns :

e_zimbra_connection_get_folders_by_type ()

EZimbraConnectionStatus e_zimbra_connection_get_folders_by_type
                                                        (EZimbraConnection *cnc,
                                                         EZimbraFolderType type,
                                                         GList **list);

cnc :

type :

list :

Returns :

e_zimbra_connection_create_folder ()

EZimbraConnectionStatus e_zimbra_connection_create_folder
                                                        (EZimbraConnection *cnc,
                                                         const gchar *parent_name,
                                                         ESource *source,
                                                         EZimbraFolderType folder_type,
                                                         gchar **folder_id,
                                                         gchar **rev);

cnc :

parent_name :

source :

folder_type :

folder_id :

rev :

Returns :

e_zimbra_connection_rename_folder ()

EZimbraConnectionStatus e_zimbra_connection_rename_folder
                                                        (EZimbraConnection *cnc,
                                                         const gchar *folder_id,
                                                         const gchar *new_name,
                                                         gchar **rev);

cnc :

folder_id :

new_name :

rev :

Returns :

e_zimbra_connection_delete_folder ()

EZimbraConnectionStatus e_zimbra_connection_delete_folder
                                                        (EZimbraConnection *cnc,
                                                         const gchar *folder_id);

cnc :

folder_id :

Returns :

e_zimbra_connection_get_message ()

EZimbraConnectionStatus e_zimbra_connection_get_message (EZimbraConnection *cnc,
                                                         const gchar *inv_id,
                                                         gchar **message);

cnc :

inv_id :

message :

Returns :

e_zimbra_connection_get_page ()

EZimbraConnectionStatus e_zimbra_connection_get_page    (EZimbraConnection *cnc,
                                                         const gchar *url,
                                                         gchar **page);

cnc :

url :

page :

Returns :

e_zimbra_connection_get_hostname ()

const gchar*        e_zimbra_connection_get_hostname    (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_use_ssl ()

gboolean            e_zimbra_connection_use_ssl         (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_get_port ()

gint                e_zimbra_connection_get_port        (EZimbraConnection *cnc);

cnc :

Returns :

e_zimbra_connection_zombie ()

gboolean            e_zimbra_connection_zombie          (EZimbraConnection *cnc);

cnc :

Returns :