camel/camel-filter-driver.h

   1 /*
   2  *  Copyright (C) 2000 Helix Code Inc.
   3  *
   4  *  Authors: Michael Zucchi <notzed@helixcode.com>
   5  *           Jeffrey Stedfast <fejj@helixcode.com>
   6  *
   7  *  This program is free software; you can redistribute it and/or
   8  *  modify it under the terms of the GNU General Public License as
   9  *  published by the Free Software Foundation; either version 2 of the
  10  *  License, or (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  20  *  USA
  21  */
  22
  23 #ifndef _CAMEL_FILTER_DRIVER_H
  24 #define _CAMEL_FILTER_DRIVER_H
  25
  26 #include <camel/camel-object.h>
  27 #include <camel/camel-session.h>
  28 #include <camel/camel-folder.h>
  29
  30 #define CAMEL_FILTER_DRIVER_TYPE   (camel_filter_driver_get_type())
  31 #define CAMEL_FILTER_DRIVER(obj)         CAMEL_CHECK_CAST (obj, camel_filter_driver_get_type (), CamelFilterDriver)
  32 #define CAMEL_FILTER_DRIVER_CLASS(klass) CAMEL__CHECK_CLASS_CAST (klass, camel_filter_driver_get_type (), CamelFilterDriverClass)
  33 #define CAMEL_IS_FILTER_DRIVER(obj)      CAMEL_CHECK_TYPE (obj, camel_filter_driver_get_type ())
  34
  35 typedef struct _CamelFilterDriver      CamelFilterDriver;
  36 typedef struct _CamelFilterDriverClass CamelFilterDriverClass;
  37
  38 struct _CamelFilterDriver {
  39         CamelObject parent;
  40
  41         struct _CamelFilterDriverPrivate *priv;
  42 };
  43
  44 struct _CamelFilterDriverClass {
  45         CamelObjectClass parent_class;
  46 };
  47
  48 /* FIXME: this maybe should change... */
  49 /* type of status for a status report */
  50 enum camel_filter_status_t {
  51         CAMEL_FILTER_STATUS_NONE,
  52         CAMEL_FILTER_STATUS_START,      /* start of new message processed */
  53         CAMEL_FILTER_STATUS_ACTION,     /* an action performed */
  54         CAMEL_FILTER_STATUS_PROGRESS,   /* (an) extra update(s), if its taking longer to process */
  55         CAMEL_FILTER_STATUS_END,        /* end of message */
  56 };
  57
  58 typedef CamelFolder * (*CamelFilterGetFolderFunc) (CamelFilterDriver *, const char *uri, void *data, CamelException *ex);
  59 /* report status */
  60 typedef void (CamelFilterStatusFunc)(CamelFilterDriver *driver, enum camel_filter_status_t status, int pc, const char *desc, void *data);
  61
  62 guint         camel_filter_driver_get_type (void);
  63 CamelFilterDriver  *camel_filter_driver_new     (CamelFilterGetFolderFunc fetcher, void *data);
  64
  65 /* modifiers */
  66 void    camel_filter_driver_set_logfile         (CamelFilterDriver *d, FILE *logfile);
  67 void    camel_filter_driver_set_status_func     (CamelFilterDriver *d, CamelFilterStatusFunc *func,
  68                                                  void *data);
  69 void    camel_filter_driver_set_default_folder  (CamelFilterDriver *d, CamelFolder *def);
  70 void    camel_filter_driver_add_rule            (CamelFilterDriver *d, const char *name, const char *match,
  71                                                  const char *action);
  72
  73 /*void camel_filter_driver_set_global(CamelFilterDriver *, const char *name, const char *value);*/
  74
  75 gboolean camel_filter_driver_filter_message      (CamelFilterDriver *driver, CamelMimeMessage *message,
  76                                                   CamelMessageInfo *info, const char *uri,
  77                                                   CamelFolder *source, const char *source_url,
  78                                                   CamelException *ex);
  79 gboolean camel_filter_driver_filter_mbox         (CamelFilterDriver *driver, const char *mbox,
  80                                                   CamelException *ex);
  81 gboolean camel_filter_driver_filter_folder       (CamelFilterDriver *driver, CamelFolder *folder,
  82                                                   GPtrArray *uids, gboolean remove, CamelException *ex);
  83
  84 #if 0
  85 /* generate the search query/action string for a filter option */
  86 void camel_filter_driver_expand_option (CamelFilterDriver *d, GString *s, GString *action, struct filter_option *op);
  87
  88 /* get info about rules (options) */
  89 int camel_filter_driver_rule_count (CamelFilterDriver *d);
  90 struct filter_option *camel_filter_driver_rule_get (CamelFilterDriver *d, int n);
  91 #endif
  92
  93 #endif /* ! _CAMEL_FILTER_DRIVER_H */