| Camel Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Prerequisites | ||||
CamelJunkFilter; enum CamelJunkStatus; gboolean camel_junk_filter_classify (CamelJunkFilter *junk_filter,CamelMimeMessage *message,CamelJunkStatus *status,GCancellable *cancellable,GError **error); gboolean camel_junk_filter_learn_junk (CamelJunkFilter *junk_filter,CamelMimeMessage *message,GCancellable *cancellable,GError **error); gboolean camel_junk_filter_learn_not_junk (CamelJunkFilter *junk_filter,CamelMimeMessage *message,GCancellable *cancellable,GError **error); gboolean camel_junk_filter_synchronize (CamelJunkFilter *junk_filter,GCancellable *cancellable,GError **error);
typedef enum {
CAMEL_JUNK_STATUS_INCONCLUSIVE,
CAMEL_JUNK_STATUS_MESSAGE_IS_JUNK,
CAMEL_JUNK_STATUS_MESSAGE_IS_NOT_JUNK
} CamelJunkStatus;
These are result codes used when passing messages through a junk filter.
gboolean camel_junk_filter_classify (CamelJunkFilter *junk_filter,CamelMimeMessage *message,CamelJunkStatus *status,GCancellable *cancellable,GError **error);
Classifies message as junk, not junk or inconclusive.
If an error occurs, the function sets error and returns FALSE.
|
a CamelJunkFilter |
|
a CamelMimeMessage |
|
location to write the CamelJunkStatus |
|
optional GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
TRUE if message was successfully classified |
Since 3.2
gboolean camel_junk_filter_learn_junk (CamelJunkFilter *junk_filter,CamelMimeMessage *message,GCancellable *cancellable,GError **error);
Instructs junk_filter to classify message as junk. If using an
adaptive junk filtering algorithm, explicitly marking message as
junk will influence the classification of future messages.
If an error occurs, the function sets error and returns FALSE.
|
a CamelJunkFilter |
|
a CamelMimeMessage |
|
optional GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
TRUE if message was successfully classified |
Since 3.2
gboolean camel_junk_filter_learn_not_junk (CamelJunkFilter *junk_filter,CamelMimeMessage *message,GCancellable *cancellable,GError **error);
Instructs junk_filter to classify message as not junk. If using an
adaptive junk filtering algorithm, explicitly marking message as not
junk will influence the classification of future messages.
If an error occurs, the function sets error and returns FALSE.
|
a CamelJunkFilter |
|
a CamelMimeMessage |
|
optional GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
TRUE if message was successfully classified |
Since 3.2
gboolean camel_junk_filter_synchronize (CamelJunkFilter *junk_filter,GCancellable *cancellable,GError **error);
Instructs junk_filter to flush any in-memory caches to disk, if
applicable. When filtering many messages, delaying this step until
all messages have been classified can improve performance.
If an error occurs, the function sets error and returns FALSE.
|
a CamelJunkFilter |
|
optional GCancellable object, or NULL
|
|
return location for a GError, or NULL
|
Returns : |
TRUE if junk_filter was successfully synchronized |
Since 3.2