git.maemo.org Git - modest/blob - libmodest-dbus-client/src/libmodest-dbus-client.h

   1 /* Copyright (c) 2007, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __LIBMODEST_DBUS_CLIENT_H__
  31 #define __LIBMODEST_DBUS_CLIENT_H__
  32
  33 #include <libosso.h>
  34 #include <glib.h>
  35 #include <stdio.h>
  36
  37
  38 /**
  39  * libmodest_dbus_client_compose_mail:
  40  * @osso_context: a valid osso_context instance
  41  * @to: the To:-field of the message
  42  * @cc: the Cc:-field of the message
  43  * @bcc: the Bcc:-field of the message
  44  * @subject: the Subject:-field of the message
  45  * @body: the body (text) of the message
  46  * @attachments: a list of (file://) URIs with the files to attach
  47  *
  48  * opens a new mail composer with the provided details filled in
  49  *
  50  * Returns: TRUE upon success, FALSE otherwise
  51  */
  52 gboolean libmodest_dbus_client_compose_mail (osso_context_t *osso_context, const gchar *to,
  53                                              const gchar *cc, const gchar *bcc, const gchar* subject,
  54                                              const gchar* body,
  55                                              GSList *attachments);
  56
  57 /**
  58  * libmodest_dbus_client_mail_to:
  59  * @osso_context: a valid osso_context instance
  60  * @mailto_uri: a 'mailto:foo@bar.cuux' URI
  61  *
  62  * opens a new mail composer with the provided details filled in,
  63  * based on a mailto: string. apart from the To:-field (the first arg),
  64  * also, cc, bcc, subject and body are supported, ie. "mailto:foo@bar.cuu?subject=test"
  65  *
  66  * Returns: TRUE upon success, FALSE otherwise
  67  */
  68 gboolean libmodest_dbus_client_mail_to (osso_context_t *osso_context,
  69                                         const gchar *mailto_uri);
  70
  71
  72 /**
  73  * libmodest_dbus_client_open_message:
  74  * @osso_context: a valid osso_context instance
  75  * @mail_uri: the unique URI referring to some message
  76  *
  77  * opens an existing message based on its URI; these URIs are unique pointers
  78  * to some message, and are retrieved from modest.
  79  *
  80  * Returns: TRUE upon success, FALSE otherwise
  81  */
  82 gboolean  libmodest_dbus_client_open_message (osso_context_t *osso_context,
  83                                               const gchar *mail_uri);
  84
  85
  86 /**
  87  * libmodest_dbus_client_send_and_receive:
  88  * @osso_context: a valid osso_context instance
  89  *
  90  * send/receive messages automatically for all accounts. This is equivalent
  91  * to the call
  92  * libmodest_dbus_client_send_and_receive_full (@osso_context, %NULL, %TRUE)
  93  *
  94  * Returns: %TRUE upon success, %FALSE otherwise
  95  */
  96 gboolean libmodest_dbus_client_send_and_receive (osso_context_t *osso_context);
  97
  98
  99
 100 /**
 101  * libmodest_dbus_client_send_and_receive_full:
 102  * @osso_context: a valid osso_context instance
 103  * @account: the account name, or %NULL to do a send receive on all accounts.
 104  * @manual: a #gboolean
 105  *
 106  * send/receive messages. If @manual is %TRUE, the send receive request
 107  * will start immediately. If @manual if %FALSE, it may wait for IP heartbeat
 108  * if enabled.
 109  *
 110  * If Modest is built without heartbeat support, then the result of the call
 111  * will be the same independently of @manual value (always immediate start).
 112  *
 113  * The call will apply to @account only, unless @account is %NULL, that means
 114  * send receive will be performed on all accounts.
 115  *
 116  * Returns: %TRUE upon success, %FALSE otherwise
 117  */
 118 gboolean libmodest_dbus_client_send_and_receive_full (osso_context_t *osso_context,
 119                                                       const gchar *account,
 120                                                       gboolean manual);
 121
 122
 123
 124 /**
 125  * libmodest_dbus_client_open_default_inbox:
 126  * @osso_context: a valid osso_context instance
 127  *
 128  * start modest, and open the inbox for the default account
 129  *
 130  * Returns: TRUE upon success, FALSE otherwise
 131  */
 132 gboolean libmodest_dbus_client_open_default_inbox (osso_context_t *osso_context);
 133
 134 /**
 135  * libmodest_dbus_client_open_account:
 136  * @osso_context: a valid osso_context instance
 137  * @account_id: the unique ID of one account
 138  *
 139  * Starts Modest showing the account that is specified as
 140  * parametter. Note that this only makes sense when the folder view is
 141  * showing just one account
 142  *
 143  * Returns: TRUE upon success, FALSE otherwise
 144  */
 145 gboolean  libmodest_dbus_client_open_account (osso_context_t *osso_context,
 146                                               const gchar *account_id);
 147
 148
 149 /*
 150  * below: functions specific to osso-global-search; not useful for other clients.
 151  *
 152  */
 153
 154 typedef enum {
 155
 156         MODEST_DBUS_SEARCH_SUBJECT   = (1 << 0),
 157         MODEST_DBUS_SEARCH_SENDER    = (1 << 1),
 158         MODEST_DBUS_SEARCH_RECIPIENT = (1 << 2),
 159         MODEST_DBUS_SEARCH_SIZE      = (1 << 3),
 160         MODEST_DBUS_SEARCH_BODY      = (1 << 6)
 161
 162 } ModestDBusSearchFlags;
 163
 164 typedef struct {
 165         gchar     *msgid; /* E.g. the URI of the message. */
 166         gchar     *subject;
 167         gchar     *folder; /* The name, not the URI. */
 168         gchar     *sender;
 169         guint64    msize;
 170         gboolean   has_attachment;
 171         gboolean   is_unread;
 172         gint64     timestamp;
 173 } ModestSearchHit;
 174
 175
 176 void modest_search_hit_list_free (GList *hits);
 177
 178
 179 gboolean libmodest_dbus_client_search            (osso_context_t          *osso_ctx,
 180                                                   const gchar             *query,
 181                                                   const gchar             *folder,
 182                                                   time_t                   start_date,
 183                                                   time_t                   end_date,
 184                                                   guint32                  min_size,
 185                                                   ModestDBusSearchFlags    flags,
 186                                                   GList                  **hits);
 187
 188 gboolean libmodest_dbus_client_delete_message   (osso_context_t   *osso_ctx,
 189                                                  const char       *msg_uri);
 190
 191
 192 typedef struct {
 193         gchar     *folder_uri;
 194         gchar     *folder_name;
 195 } ModestFolderResult;
 196
 197 gboolean libmodest_dbus_client_get_folders (osso_context_t *osso_ctx, GList **folders);
 198
 199 void modest_folder_result_list_free (GList *folders);
 200
 201
 202
 203 #endif /* __LIBMODEST_DBUS_CLIENT_H__ */