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 append_message
function).
this |
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 null |
original_store_uid |
UID of source store (pre-movemail), or null |
cancellable |
optional Cancellable object, or null |
-1 if errors were encountered during filtering, otherwise returns 0. |