camel/camel-transport.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /* camel-transport.h : Abstract class for an email transport */
   3
   4 /*
   5  *
   6  * Author :
   7  *  Dan Winship <danw@ximian.com>
   8  *
   9  * Copyright 2000 Ximian, Inc. (www.ximian.com)
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of version 2 of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  23  * USA
  24  */
  25
  26
  27 #ifndef CAMEL_TRANSPORT_H
  28 #define CAMEL_TRANSPORT_H 1
  29
  30 #include <glib.h>
  31 #include <camel/camel-service.h>
  32
  33 #define CAMEL_TRANSPORT_TYPE     (camel_transport_get_type ())
  34 #define CAMEL_TRANSPORT(obj)     (CAMEL_CHECK_CAST((obj), CAMEL_TRANSPORT_TYPE, CamelTransport))
  35 #define CAMEL_TRANSPORT_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_TRANSPORT_TYPE, CamelTransportClass))
  36 #define CAMEL_IS_TRANSPORT(o)    (CAMEL_CHECK_TYPE((o), CAMEL_TRANSPORT_TYPE))
  37
  38 G_BEGIN_DECLS
  39
  40 enum {
  41         CAMEL_TRANSPORT_ARG_FIRST  = CAMEL_SERVICE_ARG_FIRST + 100,
  42 };
  43
  44 struct _CamelTransport
  45 {
  46         CamelService parent_object;
  47
  48         struct _CamelTransportPrivate *priv;
  49 };
  50
  51
  52
  53 typedef struct {
  54         CamelServiceClass parent_class;
  55
  56         gboolean (*send_to) (CamelTransport *transport,
  57                              CamelMimeMessage *message,
  58                              CamelAddress *from, CamelAddress *recipients,
  59                              CamelException *ex);
  60 } CamelTransportClass;
  61
  62
  63 /* public methods */
  64 gboolean camel_transport_send_to (CamelTransport *transport,
  65                                   CamelMimeMessage *message,
  66                                   CamelAddress *from,
  67                                   CamelAddress *recipients,
  68                                   CamelException *ex);
  69
  70 /* Standard Camel function */
  71 CamelType camel_transport_get_type (void);
  72
  73 G_END_DECLS
  74
  75 #endif /* CAMEL_TRANSPORT_H */