camel/providers/pop3/camel-pop3-store.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /* camel-pop3-store.h : class for an pop3 store */
   3
   4 /*
   5  * Authors:
   6  *   Dan Winship <danw@ximian.com>
   7  *   Michael Zucchi <notzed@ximian.com>
   8  *
   9  * Copyright (C) 2000-2002 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_POP3_STORE_H
  28 #define CAMEL_POP3_STORE_H 1
  29
  30 #include <camel/camel-types.h>
  31 #include <camel/camel-store.h>
  32 #include "camel-pop3-engine.h"
  33
  34 #define CAMEL_POP3_STORE_TYPE     (camel_pop3_store_get_type ())
  35 #define CAMEL_POP3_STORE(obj)     (CAMEL_CHECK_CAST((obj), CAMEL_POP3_STORE_TYPE, CamelPOP3Store))
  36 #define CAMEL_POP3_STORE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_POP3_STORE_TYPE, CamelPOP3StoreClass))
  37 #define CAMEL_IS_POP3_STORE(o)    (CAMEL_CHECK_TYPE((o), CAMEL_POP3_STORE_TYPE))
  38
  39 G_BEGIN_DECLS
  40
  41 typedef struct {
  42         CamelStore parent_object;
  43
  44         CamelPOP3Engine *engine; /* pop processing engine */
  45
  46         struct _CamelDataCache *cache;
  47
  48         guint delete_after;
  49 } CamelPOP3Store;
  50
  51
  52
  53 typedef struct {
  54         CamelStoreClass parent_class;
  55
  56 } CamelPOP3StoreClass;
  57
  58
  59 /* public methods */
  60 void camel_pop3_store_expunge (CamelPOP3Store *store, CamelException *ex);
  61
  62 /* support functions */
  63 enum { CAMEL_POP3_OK, CAMEL_POP3_ERR, CAMEL_POP3_FAIL };
  64 int camel_pop3_command (CamelPOP3Store *store, char **ret, CamelException *ex, char *fmt, ...);
  65 char *camel_pop3_command_get_additional_data (CamelPOP3Store *store, int total, CamelException *ex);
  66
  67 /* Standard Camel function */
  68 CamelType camel_pop3_store_get_type (void);
  69
  70 G_END_DECLS
  71
  72 #endif /* CAMEL_POP3_STORE_H */
  73
  74