Sieve Functions

Last updated March 2020

Name	Description
sieve_arg_as_number	Get the specified argument(s) as a number
sieve_arg_as_numeric	Obtain a numeric Sieve argument from either a string or a number representation
sieve_arg_as_string	Get the specified argument as a string
sieve_arg_delref	Remove a reference to a Sieve argument
sieve_case_fold2
sieve_charset_converter_buffer_string	perform character encoding conversion
sieve_charset_converter_string_string	perform character encoding conversion
sieve_compare_compile	pre-compile matching state for a sieve comparator
sieve_compare_operands	execute a sieve comparator match
sieve_create_hash	Create a Sieve hash
sieve_create_number	Create a Sieve number
sieve_create_string	Create a Sieve string
sieve_create_string_list	Create a Sieve string list
sieve_delref	Delete a reference to a compiled Sieve script
sieve_error	Create a Sieve error message
sieve_execute	Prepare and execute a sieve script
sieve_free_seng	Free a prepared sieve engine context
sieve_get_accept_construct	Get an accept_construct from the Sieve engine
sieve_get_arg	Get the argument at the specified index
sieve_get_arg_as_numeric	obtain a numeric sieve argument from either a string or a number representation
sieve_get_arg_as_string	Return the specified argument as a string
sieve_get_arg_lineno	Get the current line number
sieve_get_arg_type	Return the type of the specified Sieve argument
sieve_get_bag	Get the bag associated with the Sieve engine
sieve_get_ec_message	Get the message associated with the Sieve engine
sieve_get_hash_item	Get the specified hash item
sieve_get_module_state	Get the current module state
sieve_get_num_args	Return the number of Sieve arguments
sieve_get_type_of_arg	Return the type of a Sieve argument
sieve_get_validation_context	Get the validation_context
sieve_hard_error	Report an error in a Sieve extension
sieve_hash_first_item	Get the first item from a hash table and add a reference to it
sieve_hash_next_item	Get the next item from a hash argument and add a reference to it
sieve_inc_counter	Increment the specified counter
sieve_next_string_arg	Return the next string argument
sieve_parse_args	Parses arguments for a Sieve extension
sieve_parse_file	Parse/compile a Sieve script from a file
sieve_parse_text	parse/compile a sieve script from a memory buffer
sieve_register_action	Register a sieve action
sieve_register_extension	Register a Sieve extension
sieve_register_test	Register a sieve test
sieve_resume	Resume the current Sieve action
sieve_return_value_append_string	Append a string to the return value
sieve_return_value_hash	Set the return value to a hash
sieve_return_value_number	Set the return value to a number
sieve_return_value_string	Set the return value to a string
sieve_return_value_string_list	Set the return value to a string list
sieve_seng_execute	Execute a prepared sieve script
sieve_seng_get_can_go_async	Determine whether or not the Sieve engine can run asynchronously
sieve_seng_prepare	prepare to execute a sieve script
sieve_seng_prepare2	Prepare to execute a Sieve script
sieve_seng_prepare3	prepare to execute a sieve script
sieve_seng_set_can_go_async	Define whether or not the Sieve engine can run asynchronously
sieve_set_error_mode	Set the error mode of the Sieve engine
sieve_set_hash_item	Set the specified hash item
sieve_set_module_state	Set the current module state
sieve_set_operation_complete	Set the action of the Sieve engine upon completion
sieve_set_response	Set an SMTP response
sieve_set_test_return_value	Set a test result return value
sieve_string_list_append	Append a value to a string list
sieve_suspend	Suspend the current Sieve action

The APIs documented here relate to the sieve module.

Was this page helpful?