X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=libmodest-dbus-client%2Flibmodest-dbus-client.h;h=03ac5d83a3a472b602b95e70596e1fbe7ae6a51f;hp=58dcd8e3f7f42d163c84a74a742a2b4d463d30f8;hb=fbe3368c6b62a1f5582f69576b77807d504e9612;hpb=ebe6325a7d8763cef1b7b508898f52a04be535d1 diff --git a/libmodest-dbus-client/libmodest-dbus-client.h b/libmodest-dbus-client/libmodest-dbus-client.h index 58dcd8e..03ac5d8 100644 --- a/libmodest-dbus-client/libmodest-dbus-client.h +++ b/libmodest-dbus-client/libmodest-dbus-client.h @@ -34,17 +34,144 @@ #include #include -gboolean -libmodest_dbus_client_call_helloworld (osso_context_t *osso_context); -gboolean -libmodfest_dbus_client_send_mail (osso_context_t *osso_context, const gchar *to, const gchar *cc, - const gchar *bcc, const gchar* subject, const gchar* body, GSList *attachments); - -gboolean -libmodfest_dbus_client_mailto (osso_context_t *osso_context, const gchar *mailto_uri); +/** + * libmodest_dbus_client_compose_mail: + * @osso_context: a valid osso_context instance + * @to: the To:-field of the message + * @cc: the Cc:-field of the message + * @bcc: the Bcc:-field of the message + * @subject: the Subject:-field of the message + * @body: the body (text) of the message + * @attachments: a list of (file://) URIs with the files to attach + * + * opens a new mail composer with the provided details filled in + * + * Returns: TRUE upon success, FALSE otherwise + */ +gboolean libmodest_dbus_client_compose_mail (osso_context_t *osso_context, const gchar *to, + const gchar *cc, const gchar *bcc, const gchar* subject, + const gchar* body, + GSList *attachments); + +/** + * libmodest_dbus_client_mail_to: + * @osso_context: a valid osso_context instance + * @mailto_uri: a 'mailto:foo@bar.cuux' URI + * + * opens a new mail composer with the provided details filled in, + * based on a mailto: string. apart from the To:-field (the first arg), + * also, cc, bcc, subject and body are supported, ie. "mailto:foo@bar.cuu?subject=test" + * + * Returns: TRUE upon success, FALSE otherwise + */ +gboolean libmodest_dbus_client_mail_to (osso_context_t *osso_context, + const gchar *mailto_uri); + + +/** + * libmodest_dbus_client_open_message: + * @osso_context: a valid osso_context instance + * @mail_uri: the unique URI referring to some message + * + * opens an existing message based on its URI; these URIs are unique pointers + * to some message, and are retrieved from modest. + * + * Returns: TRUE upon success, FALSE otherwise + */ +gboolean libmodest_dbus_client_open_message (osso_context_t *osso_context, + const gchar *mail_uri); + + +/** + * libmodest_dbus_client_send_and_receive: + * @osso_context: a valid osso_context instance + * + * send/receive messages + * + * Returns: TRUE upon success, FALSE otherwise + */ +gboolean libmodest_dbus_client_send_and_receive (osso_context_t *osso_context); + + + +/** + * libmodest_dbus_client_open_default_inbox: + * @osso_context: a valid osso_context instance + * + * start modest, and open the inbox for the default account + * + * Returns: TRUE upon success, FALSE otherwise + */ +gboolean libmodest_dbus_client_open_default_inbox (osso_context_t *osso_context); + +/** + * libmodest_dbus_client_open_account: + * @osso_context: a valid osso_context instance + * @account_id: the unique ID of one account + * + * Starts Modest showing the account that is specified as + * parametter. Note that this only makes sense when the folder view is + * showing just one account + * + * Returns: TRUE upon success, FALSE otherwise + */ +gboolean libmodest_dbus_client_open_account (osso_context_t *osso_context, + const gchar *account_id); + + +/* + * below: functions specific to osso-global-search; not useful for other clients. + * + */ + +typedef enum { + + MODEST_DBUS_SEARCH_SUBJECT = (1 << 0), + MODEST_DBUS_SEARCH_SENDER = (1 << 1), + MODEST_DBUS_SEARCH_RECIPIENT = (1 << 2), + MODEST_DBUS_SEARCH_SIZE = (1 << 3), + MODEST_DBUS_SEARCH_BODY = (1 << 6) + +} ModestDBusSearchFlags; + +typedef struct { + gchar *msgid; /* E.g. the URI of the message. */ + gchar *subject; + gchar *folder; /* The name, not the URI. */ + gchar *sender; + guint64 msize; + gboolean has_attachment; + gboolean is_unread; + gint64 timestamp; +} ModestSearchHit; + + +void modest_search_hit_list_free (GList *hits); + + +gboolean libmodest_dbus_client_search (osso_context_t *osso_ctx, + const gchar *query, + const gchar *folder, + time_t start_date, + time_t end_date, + guint32 min_size, + ModestDBusSearchFlags flags, + GList **hits); + +gboolean libmodest_dbus_client_delete_message (osso_context_t *osso_ctx, + const char *msg_uri); + + +typedef struct { + gchar *folder_uri; + gchar *folder_name; +} ModestFolderResult; + +gboolean libmodest_dbus_client_get_folders (osso_context_t *osso_ctx, GList **folders); -gboolean -libmodfest_dbus_client_open_message (osso_context_t *osso_context, const gchar *mail_uri); +void modest_folder_result_list_free (GList *folders); + + #endif /* __LIBMODEST_DBUS_CLIENT_H__ */