sieve_register_action

March 26, 2020 Contributors

Name

sieve_register_action — Register a sieve action

Synopsis

#include "sieve/ecsieve.h"

| int **sieve_register_action** ( | closure, |   |
|   | action, |   |
|   | reqd_capability, |   |
|   | compile_cb, |   |
|   | action_cb); |   |

void * <var class="pdparam">closure</var>;
const char * <var class="pdparam">action</var>;
const char * <var class="pdparam">reqd_capability</var>;
sieve_compile_callback <var class="pdparam">compile_cb</var>;
sieve_action_callback <var class="pdparam">action_cb</var>;

Description

Deprecated

Use sieve_register_extension instead.

Register a sieve action.

Parameters

flags

A combination of SIV_EXT_* flags (if any).

closure

Pointer that’s passed to callbacks.

action

Name of the extension in Sieve scripts.

reqd_capability

Name that the script needs to require; NULL means the same as action.

compile_cb

Callback for compile phase.

action_cb

Callback for execution phase.

This is equivalent to calling sieve_register_extension with the SIV_EXT_SUPPORTS_V0 flag (which introduces overhead for compatibility). New code should use sieve_register_extension instead.

Return Values

Returns 1 on success, 0 on failure.