git.maemo.org Git - modest/blob - src/modest-tny-transport-actions.h

   1 /* Copyright (c) 2006, 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
  31 /* modest-tny-transport-actions.h */
  32
  33 #ifndef __MODEST_TNY_TRANSPORT_ACTIONS_H__
  34 #define __MODEST_TNY_TRANSPORT_ACTIONS_H__
  35
  36 #include <glib-object.h>
  37 #include <tny-transport-account-iface.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* standard convenience macros */
  42 #define MODEST_TYPE_TNY_TRANSPORT_ACTIONS             (modest_tny_transport_actions_get_type())
  43 #define MODEST_TNY_TRANSPORT_ACTIONS(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_TRANSPORT_ACTIONS,ModestTnyTransportActions))
  44 #define MODEST_TNY_TRANSPORT_ACTIONS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_TRANSPORT_ACTIONS,GObject))
  45 #define MODEST_IS_TNY_TRANSPORT_ACTIONS(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_TRANSPORT_ACTIONS))
  46 #define MODEST_IS_TNY_TRANSPORT_ACTIONS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_TRANSPORT_ACTIONS))
  47 #define MODEST_TNY_TRANSPORT_ACTIONS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_TRANSPORT_ACTIONS,ModestTnyTransportActionsClass))
  48
  49 typedef struct _ModestTnyTransportActions      ModestTnyTransportActions;
  50 typedef struct _ModestTnyTransportActionsClass ModestTnyTransportActionsClass;
  51
  52 struct _ModestTnyTransportActions {
  53          GObject parent;
  54         /* insert public members, if any */
  55 };
  56
  57 struct _ModestTnyTransportActionsClass {
  58         GObjectClass parent_class;
  59         /* insert signal callback declarations, eg. */
  60         /* void (* my_event) (ModestTnyTransportActions* obj); */
  61 };
  62
  63 /* member functions */
  64 GType        modest_tny_transport_actions_get_type    (void) G_GNUC_CONST;
  65
  66 /* typical parameter-less _new function */
  67 /* if this is a kind of GtkWidget, it should probably return at GtkWidget*, */
  68 /*    otherwise probably a GObject*. */
  69 GObject*    modest_tny_transport_actions_new         (void);
  70
  71
  72 /**
  73  * modest_tny_transport_actions_send_message:
  74  * @self: a ModestTnyTransportActions object
  75  * @transport_account: the TnyTransportAccountIface to use for sending this message
  76  * @from: the email address of the sender
  77  * @to: the email address of the receiver
  78  * @cc: the receivers of a copy of the message (comma-seperated)
  79  * @bcc: the receivers of a blind copy of the message (comma-seperated)
  80  * @subject: the Subject: of the message
  81  * @body: a string containing the message body (text)
  82  *
  83  * send a email message to @to
  84  *
  85  * Returns: TRUE but this will change to whether sending was successful
  86  */
  87 gboolean modest_tny_transport_actions_send_message (ModestTnyTransportActions *self,
  88                                                     TnyTransportAccountIface *transport_account,
  89                                                     const gchar *from,
  90                                                     const gchar *to,
  91                                                     const gchar *cc,
  92                                                     const gchar *bcc,
  93                                                     const gchar *subject,
  94                                                     const gchar *body,
  95                                                     const GList *attachments_list);
  96
  97 G_END_DECLS
  98
  99 #endif /* __MODEST_TNY_TRANSPORT_ACTIONS_H__ */
 100