/**
* camel_junk_filter_learn_junk:
* @junk_filter: a #CamelJunkFilter
* @message: a #CamelMimeMessage
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
*
* 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.
*
* 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)
{
CamelJunkFilterInterface *interface;
g_return_val_if_fail (CAMEL_IS_JUNK_FILTER (junk_filter), FALSE);
g_return_val_if_fail (CAMEL_IS_MIME_MESSAGE (message), FALSE);
interface = CAMEL_JUNK_FILTER_GET_INTERFACE (junk_filter);
g_return_val_if_fail (interface->learn_junk != NULL, FALSE);
return interface->learn_junk (
junk_filter, message, cancellable, error);
}
/**
* camel_junk_filter_classify:
* @junk_filter: a #CamelJunkFilter
* @message: a #CamelMimeMessage
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
*
* Classifies @message as junk, not junk or inconclusive.
*
* If an error occurs, the function sets @error and returns
* %CAMEL_JUNK_STATUS_ERROR.
*
* Returns: the junk status determined by @junk_filter
*
* Since: 3.2
**/
CamelJunkStatus
camel_junk_filter_classify (CamelJunkFilter *junk_filter,
CamelMimeMessage *message,
GCancellable *cancellable,
GError **error)
{
CamelJunkFilterInterface *interface;
g_return_val_if_fail (CAMEL_IS_JUNK_FILTER (junk_filter), 0);
g_return_val_if_fail (CAMEL_IS_MIME_MESSAGE (message), 0);
interface = CAMEL_JUNK_FILTER_GET_INTERFACE (junk_filter);
g_return_val_if_fail (interface->classify != NULL, 0);
return interface->classify (
junk_filter, message, cancellable, error);
}
/**
* camel_junk_filter_synchronize:
* @junk_filter: a #CamelJunkFilter
* @cancellable: optional #GCancellable object, or %NULL
* @error: return location for a #GError, or %NULL
*
* 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.
*
* Returns: %TRUE if @junk_filter was successfully synchronized
*
* Since: 3.2
**/
gboolean
camel_junk_filter_synchronize (CamelJunkFilter *junk_filter,
GCancellable *cancellable,
GError **error)
{
CamelJunkFilterInterface *interface;
gboolean success = TRUE;
g_return_val_if_fail (CAMEL_IS_JUNK_FILTER (junk_filter), FALSE);
/* This method is optional. */
interface = CAMEL_JUNK_FILTER_GET_INTERFACE (junk_filter);
if (interface->synchronize != NULL)
success = interface->synchronize (
junk_filter, cancellable, error);
return success;
}
