/usr/include/dovecot/sieve/sieve.h is in dovecot-dev 1:2.2.9-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | /* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
*/
#ifndef __SIEVE_H
#define __SIEVE_H
struct sieve_script;
struct sieve_binary;
#include "sieve-config.h"
#include "sieve-types.h"
#include "sieve-error.h"
/*
* Main Sieve library interface
*/
/* sieve_init():
* Initializes the sieve engine. Must be called before any sieve functionality
* is used.
*/
struct sieve_instance *sieve_init
(const struct sieve_environment *env, const struct sieve_callbacks *callbacks,
void *context, bool debug);
/* sieve_deinit():
* Frees all memory allocated by the sieve engine.
*/
void sieve_deinit(struct sieve_instance **svinst);
/* sieve_get_capabilities():
*
*/
const char *sieve_get_capabilities
(struct sieve_instance *svinst, const char *name);
/* sieve_set_extensions():
*
*/
void sieve_set_extensions
(struct sieve_instance *svinst, const char *extensions);
/*
* Script compilation
*/
/* sieve_compile_script:
*/
struct sieve_binary *sieve_compile_script
(struct sieve_script *script, struct sieve_error_handler *ehandler,
enum sieve_compile_flags flags, enum sieve_error *error_r);
/* sieve_compile:
*
* Compiles the script into a binary.
*/
struct sieve_binary *sieve_compile
(struct sieve_instance *svinst, const char *script_location,
const char *script_name, struct sieve_error_handler *ehandler,
enum sieve_compile_flags flags, enum sieve_error *error_r);
/*
* Reading/writing Sieve binaries
*/
/* sieve_load:
*
* Loads the sieve binary indicated by the provided path.
*/
struct sieve_binary *sieve_load
(struct sieve_instance *svinst, const char *bin_path,
enum sieve_error *error_r);
/* sieve_open_script:
*
* First tries to open the binary version of the specified script and if it
* does not exist or if it contains errors, the script is (re-)compiled. Note
* that errors in the bytecode are caught only at runtime.
*/
struct sieve_binary *sieve_open_script
(struct sieve_script *script, struct sieve_error_handler *ehandler,
enum sieve_compile_flags flags, enum sieve_error *error_r);
/* sieve_open:
*
* First tries to open the binary version of the specified script and if it
* does not exist or if it contains errors, the script is (re-)compiled. Note
* that errors in the bytecode are caught only at runtime.
*/
struct sieve_binary *sieve_open
(struct sieve_instance *svinst, const char *script_location,
const char *script_name, struct sieve_error_handler *ehandler,
enum sieve_compile_flags flags, enum sieve_error *error_r);
/* sieve_save_as:
*
* Saves the binary as the file indicated by the path parameter. This function
* will not write the binary to disk when it was loaded from the indicated
* bin_path, unless update is TRUE.
*/
int sieve_save_as
(struct sieve_binary *sbin, const char *bin_path, bool update,
mode_t save_mode, enum sieve_error *error_r);
/* sieve_save:
*
* Saves the binary to the default location. This function will not overwrite
* the binary it was loaded earlier from the default location, unless update
* is TRUE.
*/
int sieve_save
(struct sieve_binary *sbin, bool update, enum sieve_error *error_r);
/* sieve_close:
*
* Closes a compiled/opened sieve binary.
*/
void sieve_close(struct sieve_binary **sbin);
/* sieve_get_source:
*
* Obtains the path the binary was compiled or loaded from
*/
const char *sieve_get_source(struct sieve_binary *sbin);
/*
* sieve_is_loeded:
*
* Indicates whether the binary was loaded from a pre-compiled file.
*/
bool sieve_is_loaded(struct sieve_binary *sbin);
/*
* Debugging
*/
/* sieve_dump:
*
* Dumps the byte code in human-readable form to the specified ostream.
*/
void sieve_dump
(struct sieve_binary *sbin, struct ostream *stream, bool verbose);
/* sieve_hexdump:
*
* Dumps the byte code in hexdump form to the specified ostream.
*/
void sieve_hexdump
(struct sieve_binary *sbin, struct ostream *stream);
/* sieve_test:
*
* Executes the bytecode, but only prints the result to the given stream.
*/
int sieve_test
(struct sieve_binary *sbin, const struct sieve_message_data *msgdata,
const struct sieve_script_env *senv, struct sieve_error_handler *ehandler,
struct ostream *stream, enum sieve_runtime_flags flags, bool *keep);
/*
* Script execution
*/
/* sieve_execute:
*
* Executes the binary, including the result.
*/
int sieve_execute
(struct sieve_binary *sbin, const struct sieve_message_data *msgdata,
const struct sieve_script_env *senv, struct sieve_error_handler *ehandler,
enum sieve_runtime_flags flags, bool *keep);
/*
* Multiscript support
*/
struct sieve_multiscript;
struct sieve_multiscript *sieve_multiscript_start_execute
(struct sieve_instance *svinst, const struct sieve_message_data *msgdata,
const struct sieve_script_env *senv);
struct sieve_multiscript *sieve_multiscript_start_test
(struct sieve_instance *svinst, const struct sieve_message_data *msgdata,
const struct sieve_script_env *senv, struct ostream *stream);
bool sieve_multiscript_run
(struct sieve_multiscript *mscript, struct sieve_binary *sbin,
struct sieve_error_handler *ehandler, enum sieve_runtime_flags flags,
bool final);
int sieve_multiscript_status(struct sieve_multiscript *mscript);
int sieve_multiscript_tempfail(struct sieve_multiscript **mscript,
struct sieve_error_handler *ehandler);
int sieve_multiscript_finish
(struct sieve_multiscript **mscript, struct sieve_error_handler *ehandler,
bool *keep);
/*
* Configured limits
*/
unsigned int sieve_max_redirects(struct sieve_instance *svinst);
unsigned int sieve_max_actions(struct sieve_instance *svinst);
size_t sieve_max_script_size(struct sieve_instance *svinst);
/*
* Script directory
*/
struct sieve_directory;
struct sieve_directory *sieve_directory_open
(struct sieve_instance *svinst, const char *path, enum sieve_error *error_r);
const char *sieve_directory_get_scriptfile(struct sieve_directory *sdir);
void sieve_directory_close(struct sieve_directory **sdir);
#endif
|