Top | ![]() |
![]() |
![]() |
![]() |
|
(*CamelFilterGetFolderFunc) () |
|
(*CamelFilterStatusFunc) () |
|
(*CamelFilterShellFunc) () |
|
(*CamelFilterPlaySoundFunc) () |
|
(*CamelFilterSystemBeepFunc) () |
|
camel_filter_driver_new () |
|
camel_filter_driver_set_logfile () |
|
camel_filter_driver_set_status_func () |
|
camel_filter_driver_set_shell_func () |
|
camel_filter_driver_set_play_sound_func () |
|
camel_filter_driver_set_system_beep_func () |
|
camel_filter_driver_set_folder_func () |
|
camel_filter_driver_set_default_folder () |
|
camel_filter_driver_add_rule () |
|
camel_filter_driver_remove_rule_by_name () |
|
camel_filter_driver_flush () |
|
camel_filter_driver_filter_message () |
|
camel_filter_driver_filter_mbox () |
|
camel_filter_driver_filter_folder () |
|
camel_filter_driver_log_info () |
CamelFolder * (*CamelFilterGetFolderFunc) (,
CamelFilterDriver *driverconst
,gchar *uri,
gpointer user_data);
GError **error
void (*CamelFilterStatusFunc) (,
CamelFilterDriver *driverenum camel_filter_status_t status
,,
gint pcconst
,gchar *desc);
gpointer user_data
void (*CamelFilterShellFunc) (,
CamelFilterDriver *driver,
gint argc,
gchar **argv);
gpointer user_data
void (*CamelFilterPlaySoundFunc) (,
CamelFilterDriver *driverconst
,gchar *filename);
gpointer user_data
void (*CamelFilterSystemBeepFunc) (,
CamelFilterDriver *driver);
gpointer user_data
CamelFilterDriver * camel_filter_driver_new (struct _CamelSession *session
);
void camel_filter_driver_set_logfile (,
CamelFilterDriver *d);
FILE *logfile
Sets a log file to use for logging.
void camel_filter_driver_set_status_func (,
CamelFilterDriver *dCamelFilterStatusFunc func
,);
gpointer user_data
Sets a status callback, which is used to report progress/status.
void camel_filter_driver_set_shell_func (,
CamelFilterDriver *dCamelFilterShellFunc func
,);
gpointer user_data
Sets a shell command callback, which is called when a shell command execution is requested.
void camel_filter_driver_set_play_sound_func (,
CamelFilterDriver *dCamelFilterPlaySoundFunc func
,);
gpointer user_data
Sets a callback to call when a play of a sound is requested.
void camel_filter_driver_set_system_beep_func (,
CamelFilterDriver *dCamelFilterSystemBeepFunc func
,);
gpointer user_data
Sets a callback to use for system beep.
void camel_filter_driver_set_folder_func (,
CamelFilterDriver *dCamelFilterGetFolderFunc get_folder
,);
gpointer user_data
Sets a callback (of type CamelFilterGetFolderFunc) to get a folder.
void camel_filter_driver_set_default_folder (,
CamelFilterDriver *d);
CamelFolder *def
Sets a default folder for the driver. The function adds its own reference for the folder.
void camel_filter_driver_add_rule (,
CamelFilterDriver *dconst
,gchar *nameconst
,gchar *matchconst
);gchar *action
Adds a new rule to set of rules to process by the filter driver.
gboolean camel_filter_driver_remove_rule_by_name (,
CamelFilterDriver *dconst
);gchar *name
Removes a rule by name, added by camel_filter_driver_add_rule()
.
void camel_filter_driver_flush (,
CamelFilterDriver *driver);
GError **error
Flush all of the only-once filter actions.
gint camel_filter_driver_filter_message (,
CamelFilterDriver *driver,
CamelMimeMessage *message,
CamelMessageInfo *infoconst
,gchar *uid,
CamelFolder *sourceconst
,gchar *store_uidconst
,gchar *original_store_uid,
GCancellable *cancellable);
GError **error
Filters a message based on rules defined in the FilterDriver
object. If the source folder (source
) and the uid (uid
) are
provided, the filter will operate on the CamelFolder (which in
certain cases is more efficient than using the default
camel_folder_append_message()
function).
driver |
CamelFilterDriver |
|
message |
message to filter or NULL |
|
info |
message info or NULL |
|
uid |
message uid or NULL |
|
source |
source folder or NULL |
|
store_uid |
UID of source store, or |
|
original_store_uid |
UID of source store (pre-movemail), or |
|
cancellable |
optional |
|
error |
return location for a |
gint camel_filter_driver_filter_mbox (,
CamelFilterDriver *driverconst
,gchar *mboxconst
,gchar *original_source_url,
GCancellable *cancellable);
GError **error
Filters an mbox file based on rules defined in the FilterDriver object. Is more efficient as it doesn't need to open the folder through Camel directly.
gint camel_filter_driver_filter_folder (,
CamelFilterDriver *driver,
CamelFolder *folderCamelUIDCache *cache
,,
GPtrArray *uids,
gboolean remove,
GCancellable *cancellable);
GError **error
Filters a folder based on rules defined in the FilterDriver object.
driver |
CamelFilterDriver |
|
folder |
CamelFolder to be filtered |
|
cache |
UID cache (needed for POP folders) |
|
uids |
message uids to be filtered or NULL (as a shortcut to filter all messages). |
[element-type utf8] |
remove |
TRUE to mark filtered messages as deleted |
|
cancellable |
optional |
|
error |
return location for a |
void camel_filter_driver_log_info (,
CamelFilterDriver *driverconst
,gchar *format...
);
Logs an informational message to a filter log. The function does
nothing when driver
is NULL
driver
.
driver |
a |
[nullable] |
format |
a printf-like format to use for the informational log entry |
|
... |
arguments for |
Since: 3.24