aboutsummaryrefslogtreecommitdiffstats
path: root/lib/librspamdclient.h
blob: 54695a34d35d19eaf7a2f87afaab1628ff6b7e15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
#ifndef LIBRSPAMD_CLIENT_H
#define LIBRSPAMD_CLIENT_H

#include <glib.h>

/**
 * Struct for representing symbols
 */
struct rspamd_symbol {
	gchar *name;		    /**< name */
	gchar *description;		/**< description */
	double weight;			/**< weight */
	GList *options;			/**< List of options (as const gchar *) */
};

/**
 * Struct for representing metrics
 */
struct rspamd_metric {
	gchar *name;
	gchar *action;
	double score;
	double required_score;
	double reject_score;
	gboolean is_skipped;
	GHashTable *symbols;
};

struct rspamd_connection;
struct rspamd_client;
/**
 * Result of scan
 */
struct rspamd_result {
	struct rspamd_connection *conn;
	gboolean is_ok;
	GHashTable *metrics;
	GHashTable *headers;
};

/*
 * Init rspamd client library
 */
struct rspamd_client* rspamd_client_init (void);

/*
 * Add rspamd server
 */
gboolean rspamd_add_server (struct rspamd_client* client, const gchar *host,
		guint16 port, guint16 controller_port, GError **err);

/*
 * Set timeouts (values in milliseconds)
 */
void rspamd_set_timeout (struct rspamd_client* client, guint connect_timeout, guint read_timeout);

/*
 * Scan message from memory
 */
struct rspamd_result * rspamd_scan_memory (struct rspamd_client* client, const guchar *message, gsize length, GHashTable *headers, GError **err);

/*
 * Scan message from file
 */
struct rspamd_result * rspamd_scan_file (struct rspamd_client* client, const guchar *filename, GHashTable *headers, GError **err);

/*
 * Scan message from fd
 */
struct rspamd_result * rspamd_scan_fd (struct rspamd_client* client, int fd, GHashTable *headers, GError **err);

/*
 * Learn message from memory
 */
gboolean rspamd_learn_spam_memory (struct rspamd_client* client, const guchar *message, gsize length, const gchar *classifier, gboolean is_spam, const gchar *password, GError **err);

/*
 * Learn message from file
 */
gboolean rspamd_learn_spam_file (struct rspamd_client* client, const guchar *filename, const gchar *classifier, gboolean is_spam, const gchar *password, GError **err);

/*
 * Learn message from fd
 */
gboolean rspamd_learn_spam_fd (struct rspamd_client* client, int fd, const gchar *classifier, gboolean is_spam, const gchar *password, GError **err);

/*
 * Learn message from memory
 */
gboolean rspamd_learn_memory (struct rspamd_client* client, const guchar *message, gsize length, const gchar *symbol, const gchar *password, GError **err);

/*
 * Learn message from file
 */
gboolean rspamd_learn_file (struct rspamd_client* client, const guchar *filename, const gchar *symbol, const gchar *password, GError **err);

/*
 * Learn message from fd
 */
gboolean rspamd_learn_fd (struct rspamd_client* client, int fd, const gchar *symbol, const gchar *password, GError **err);

/*
 * Learn message fuzzy from memory
 */
gboolean rspamd_fuzzy_memory (struct rspamd_client* client, const guchar *message, gsize length, const gchar *password, gint weight, gint flag, gboolean delete, GError **err);

/*
 * Learn message fuzzy from file
 */
gboolean rspamd_fuzzy_file (struct rspamd_client* client, const guchar *filename, const gchar *password, gint weight, gint flag, gboolean delete, GError **err);

/*
 * Learn message fuzzy from fd
 */
gboolean rspamd_fuzzy_fd (struct rspamd_client* client, int fd, const gchar *password, gint weight, gint flag, gboolean delete, GError **err);

/*
 * Get statistic from server
 */
GString *rspamd_get_stat (struct rspamd_client* client, GError **err);

/*
 * Get uptime from server
 */
GString *rspamd_get_uptime (struct rspamd_client* client, GError **err);

/*
 * Free results
 */
void rspamd_free_result (struct rspamd_result *result);

/*
 * Close library and free associated resources
 */
void rspamd_client_close (struct rspamd_client *client);

#endif