src/plugins/bogofilter/bogofilter.h

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2012 Colin Leroy <colin@colino.net> and
   4  * the Claws Mail team
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 #ifndef BOGOFILTER_H
  22 #define BOGOFILTER_H 1
  23
  24 #include <glib.h>
  25 #include "folder.h"
  26
  27 typedef struct _BogofilterConfig BogofilterConfig;
  28
  29 typedef void (*MessageCallback) (gchar *, gint total, gint done, gboolean thread_safe);
  30
  31 struct _BogofilterConfig
  32 {
  33         gboolean                 process_emails;
  34         guint                            receive_spam;
  35         gchar                   *save_folder;
  36         guint                    max_size;
  37         gchar                   *bogopath;
  38         gboolean                 insert_header;
  39         gboolean                 whitelist_ab;
  40         gchar                   *whitelist_ab_folder;
  41         gboolean                 learn_from_whitelist;
  42         gboolean                 save_unsure;
  43         gchar                   *save_unsure_folder;
  44         gboolean                 mark_as_read;
  45 };
  46
  47 /* Used for values of receive_spam preference. */
  48 enum {
  49         SPAM_DELETE,
  50         SPAM_MARK_AND_SAVE,
  51         SPAM_MARK_ONLY
  52 };
  53
  54 BogofilterConfig *bogofilter_get_config       (void);
  55 void                bogofilter_save_config            (void);
  56 void                bogofilter_set_message_callback (MessageCallback callback);
  57 gint bogofilter_gtk_init(void);
  58 void bogofilter_gtk_done(void);
  59 int bogofilter_learn(MsgInfo *msginfo, GSList *msglist, gboolean spam);
  60 void bogofilter_register_hook(void);
  61 void bogofilter_unregister_hook(void);
  62 FolderItem *bogofilter_get_spam_folder(MsgInfo *msginfo);
  63 #endif