Bug 1454: Option -oMm for message reference
[exim.git] / src / src / functions.h
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5a66c31b 5/* Copyright (c) University of Cambridge 1995 - 2014 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8
9/* Prototypes for functions that appear in various modules. Gathered together
10to avoid having a lot of tiddly little headers with only a couple of lines in
11them. However, some functions that are used (or not used) by utility programs
12are in in fact in separate headers. */
13
14
15#ifdef EXIM_PERL
16extern uschar *call_perl_cat(uschar *, int *, int *, uschar **, uschar *,
17 uschar **);
18extern void cleanup_perl(void);
19extern uschar *init_perl(uschar *);
20#endif
21
22
23#ifdef SUPPORT_TLS
a799883d
PP
24extern const char *
25 std_dh_prime_default(void);
26extern const char *
27 std_dh_prime_named(const uschar *);
f5d78688 28extern int tls_client_start(int, host_item *, address_item *,
83da1223 29 uschar *, uschar *, uschar *, uschar *, uschar *, uschar *,
f5d78688
JH
30# ifdef EXPERIMENTAL_OCSP
31 uschar *,
32# endif
a63be306 33 int, int, uschar *, uschar *);
817d9f57 34extern void tls_close(BOOL, BOOL);
059ec3d9
PH
35extern int tls_feof(void);
36extern int tls_ferror(void);
37extern int tls_getc(void);
817d9f57 38extern int tls_read(BOOL, uschar *, size_t);
17c76198 39extern int tls_server_start(const uschar *);
58eb016e 40extern BOOL tls_smtp_buffered(void);
059ec3d9 41extern int tls_ungetc(int);
389ca47a 42extern int tls_write(BOOL, const uschar *, size_t);
3375e053 43extern uschar *tls_validate_require_cipher(void);
36f12725 44extern void tls_version_report(FILE *);
77bb000f
PP
45#ifndef USE_GNUTLS
46extern BOOL tls_openssl_options_parse(uschar *, long *);
47#endif
35aba663 48#endif /*SUPPORT_TLS*/
059ec3d9
PH
49
50
51/* Everything else... */
52
53extern acl_block *acl_read(uschar *(*)(void), uschar **);
54extern int acl_check(int, uschar *, uschar *, uschar **, uschar **);
05caaeaa 55extern int acl_eval(int, uschar *, uschar **, uschar **);
333eea9c 56
38a0a95f
PH
57extern tree_node *acl_var_create(uschar *);
58extern void acl_var_write(uschar *, uschar *, void *);
059ec3d9
PH
59extern uschar *auth_b64encode(uschar *, int);
60extern int auth_b64decode(uschar *, uschar **);
61extern int auth_call_pam(uschar *, uschar **);
62extern int auth_call_pwcheck(uschar *, uschar **);
63extern int auth_call_radius(uschar *, uschar **);
64extern int auth_call_saslauthd(uschar *, uschar *, uschar *, uschar *,
65 uschar **);
16ff981e 66extern int auth_check_serv_cond(auth_instance *);
44bbabb5
PP
67extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
68
059ec3d9
PH
69extern int auth_get_data(uschar **, uschar *, int);
70extern int auth_get_no64_data(uschar **, uschar *);
71extern uschar *auth_xtextencode(uschar *, int);
72extern int auth_xtextdecode(uschar *, uschar **);
73
2e5b33cd 74extern void cancel_cutthrough_connection(const char *);
32d668a5 75extern int check_host(void *, uschar *, uschar **, uschar **);
059ec3d9
PH
76extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
77extern pid_t child_open_uid(uschar **, uschar **, int, uid_t *, gid_t *,
78 int *, int *, uschar *, BOOL);
e4bdf652
JH
79extern uschar *cutthrough_finaldot(void);
80extern BOOL cutthrough_flush_send(void);
81extern BOOL cutthrough_headers_send(void);
82extern BOOL cutthrough_predata(void);
83extern BOOL cutthrough_puts(uschar *, int);
84extern BOOL cutthrough_put_nl(void);
059ec3d9
PH
85
86extern void daemon_go(void);
6a8f9482
TK
87
88#ifdef EXPERIMENTAL_DCC
89extern int dcc_process(uschar **);
90#endif
91
ed7f7860 92extern void debug_logging_activate(uschar *, uschar *);
059ec3d9
PH
93extern void debug_print_argv(uschar **);
94extern void debug_print_ids(uschar *);
95extern void debug_print_string(uschar *);
96extern void debug_print_tree(tree_node *);
1ba28e2b 97extern void debug_vprintf(const char *, va_list);
ed7f7860
PP
98extern void decode_bits(unsigned int *, unsigned int *,
99 int, int, uschar *, bit_table *, int, uschar *, int);
059ec3d9 100extern address_item *deliver_make_addr(uschar *, BOOL);
817d9f57 101extern void delivery_log(int, address_item *, int, uschar *);
059ec3d9 102extern int deliver_message(uschar *, BOOL, BOOL);
e0df1c83 103extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH
104extern void deliver_set_expansions(address_item *);
105extern int deliver_split_address(address_item *);
106extern void deliver_succeeded(address_item *);
8523533c
TK
107#ifdef WITH_OLD_DEMIME
108extern int demime(uschar **);
109#endif
1ba28e2b 110extern BOOL directory_make(const uschar *, const uschar *, int, BOOL);
80a47a2c 111#ifndef DISABLE_DKIM
f7572e5a
TK
112extern BOOL dkim_transport_write_message(address_item *, int, int,
113 int, uschar *, uschar *, uschar *, uschar *, rewrite_rule *,
80a47a2c 114 int, uschar *, uschar *, uschar *, uschar *, uschar *, uschar *);
f7572e5a 115#endif
059ec3d9
PH
116extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
117extern void dns_build_reverse(uschar *, uschar *);
8c51eead 118extern void dns_init(BOOL, BOOL, BOOL);
059ec3d9 119extern int dns_basic_lookup(dns_answer *, uschar *, int);
1f4a55da 120extern BOOL dns_is_secure(dns_answer *);
059ec3d9 121extern int dns_lookup(dns_answer *, uschar *, int, uschar **);
33397d19 122extern int dns_special_lookup(dns_answer *, uschar *, int, uschar **);
059ec3d9
PH
123extern dns_record *dns_next_rr(dns_answer *, dns_scan *, int);
124extern uschar *dns_text_type(int);
36a3ae5f 125extern void dscp_list_to_stream(FILE *);
9e4f5962 126extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *);
059ec3d9
PH
127
128extern void enq_end(uschar *);
129extern BOOL enq_start(uschar *);
130extern void exim_exit(int);
131extern void exim_nullstd(void);
132extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
133extern int exim_tvcmp(struct timeval *, struct timeval *);
134extern void exim_wait_tick(struct timeval *, int);
135extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
136extern uschar *expand_string(uschar *);
137extern uschar *expand_string_copy(uschar *);
97d17305 138extern int_eximarith_t expand_string_integer(uschar *, BOOL);
d9b2312b 139extern void modify_variable(uschar *, void *);
059ec3d9
PH
140
141extern int filter_interpret(uschar *, int, address_item **, uschar **);
142extern BOOL filter_personal(string_item *, BOOL);
f05da2e8 143extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
059ec3d9
PH
144extern BOOL filter_system_interpret(address_item **, uschar **);
145
362145b5
JH
146extern uschar * fn_hdrs_added(void);
147
1ba28e2b 148extern void header_add(int, const char *, ...);
059ec3d9
PH
149extern int header_checkname(header_line *, BOOL);
150extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
7cd1141b 151extern int host_address_extract_port(uschar *);
059ec3d9
PH
152extern uschar *host_and_ident(BOOL);
153extern int host_aton(uschar *, int *);
154extern void host_build_hostlist(host_item **, uschar *, BOOL);
155extern ip_address_item *host_build_ifacelist(uschar *, uschar *);
156extern void host_build_log_info(void);
157extern void host_build_sender_fullhost(void);
322050c2 158extern BOOL host_find_byname(host_item *, uschar *, int, uschar **, BOOL);
059ec3d9 159extern int host_find_bydns(host_item *, uschar *, int, uschar *, uschar *,
8c51eead 160 uschar *, uschar *, uschar *, uschar **, BOOL *);
059ec3d9
PH
161extern ip_address_item *host_find_interfaces(void);
162extern BOOL host_is_in_net(uschar *, uschar *, int);
163extern BOOL host_is_tls_on_connect_port(int);
7cd1141b 164extern int host_item_get_port(host_item *);
059ec3d9
PH
165extern void host_mask(int, int *, int);
166extern int host_name_lookup(void);
6f0c9a4f 167extern int host_nmtoa(int, int *, int, uschar *, int);
059ec3d9
PH
168extern uschar *host_ntoa(int, const void *, uschar *, int *);
169extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
170
83e029d5 171extern void invert_address(uschar *, uschar *);
059ec3d9
PH
172extern int ip_bind(int, int, uschar *, int);
173extern int ip_connect(int, int, uschar *, int, int);
b1f8e4f8
JH
174extern int ip_connectedsocket(int, const uschar *, int, int,
175 int, host_item *, uschar **);
13363eba 176extern int ip_get_address_family(int);
059ec3d9
PH
177extern void ip_keepalive(int, uschar *, BOOL);
178extern int ip_recv(int, uschar *, int, int);
179extern int ip_socket(int, int);
180
921b12ca 181extern uschar *local_part_quote(uschar *);
4840604e 182extern int log_create(uschar *);
921b12ca 183extern int log_create_as_exim(uschar *);
059ec3d9
PH
184extern void log_close_all(void);
185
8523533c
TK
186#ifdef WITH_CONTENT_SCAN
187extern int malware(uschar **);
dbc4b90d 188extern int malware_in_file(uschar *);
8523533c 189#endif
059ec3d9
PH
190extern int match_address_list(uschar *, BOOL, BOOL, uschar **,
191 unsigned int *, int, int, uschar **);
192extern int match_check_list(uschar **, int, tree_node **, unsigned int **,
193 int(*)(void *, uschar *, uschar **, uschar **), void *, int,
194 uschar *, uschar **);
195extern int match_isinlist(uschar *, uschar **, int, tree_node **,
196 unsigned int *, int, BOOL, uschar **);
197extern int match_check_string(uschar *, uschar *, int, BOOL, BOOL, BOOL,
198 uschar **);
199extern void md5_end(md5 *, const uschar *, int, uschar *);
200extern void md5_mid(md5 *, const uschar *);
201extern void md5_start(md5 *);
202extern void millisleep(int);
8523533c
TK
203#ifdef WITH_CONTENT_SCAN
204struct mime_boundary_context;
54cdb463
PH
205extern int mime_acl_check(uschar *acl, FILE *f,
206 struct mime_boundary_context *, uschar **, uschar **);
8523533c
TK
207extern int mime_decode(uschar **);
208extern int mime_regex(uschar **);
209#endif
059ec3d9
PH
210extern uschar *moan_check_errorcopy(uschar *);
211extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
212 BOOL, uschar *);
e0df1c83 213extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
1ba28e2b 214extern void moan_tell_someone(uschar *, address_item *,
e0df1c83 215 const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
059ec3d9 216extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
0e22dfd1 217extern void moan_write_from(FILE *);
1ba28e2b 218extern FILE *modefopen(const uschar *, const char *, mode_t);
059ec3d9 219
e4bdf652
JH
220extern void open_cutthrough_connection( address_item * addr );
221
059ec3d9
PH
222extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
223 BOOL);
224extern int parse_forward_list(uschar *, int, address_item **, uschar **,
225 uschar *, uschar *, error_block **);
226extern uschar *parse_find_address_end(uschar *, BOOL);
227extern uschar *parse_find_at(uschar *);
228extern uschar *parse_fix_phrase(uschar *, int, uschar *, int);
30dba1e6 229extern uschar *parse_message_id(uschar *, uschar **, uschar **);
46218253 230extern uschar *parse_quote_2047(uschar *, int, uschar *, uschar *, int, BOOL);
43ad7b7d 231extern uschar *parse_date_time(uschar *str, time_t *t);
17c76198
PP
232extern int vaguely_random_number(int);
233#ifdef SUPPORT_TLS
234extern int vaguely_random_number_fallback(int);
235#endif
059ec3d9
PH
236
237extern BOOL queue_action(uschar *, int, uschar **, int, int);
238extern void queue_check_only(void);
239extern void queue_list(int, uschar **, int);
240extern void queue_count(void);
241extern void queue_run(uschar *, uschar *, BOOL);
242
243extern int random_number(int);
8523533c
TK
244#ifdef WITH_CONTENT_SCAN
245extern int recv_line(int, uschar *, int);
246#endif
e4a89c47 247extern int rda_interpret(redirect_block *, int, uschar *, uschar *,
efd9a422
MH
248 uschar *, uschar *, uschar *, ugid_block *, address_item **,
249 uschar **, error_block **, int *, uschar *);
059ec3d9
PH
250extern int rda_is_filter(const uschar *);
251extern BOOL readconf_depends(driver_instance *, uschar *);
252extern void readconf_driver_init(uschar *, driver_instance **,
253 driver_info *, int, void *, int, optionlist *, int);
254extern uschar *readconf_find_option(void *);
255extern void readconf_main(void);
12f69989 256extern void readconf_print(uschar *, uschar *, BOOL);
059ec3d9
PH
257extern uschar *readconf_printtime(int);
258extern uschar *readconf_readname(uschar *, int, uschar *);
259extern int readconf_readtime(uschar *, int, BOOL);
cb46fd2b 260extern void readconf_rest();
059ec3d9 261extern uschar *readconf_retry_error(uschar *, uschar *, int *, int *);
328895cc 262extern void read_message_body(BOOL);
8f128379 263extern void receive_bomb_out(uschar *, uschar *);
059ec3d9
PH
264extern BOOL receive_check_fs(int);
265extern BOOL receive_check_set_sender(uschar *);
266extern BOOL receive_msg(BOOL);
8e669ac1 267extern int receive_statvfs(BOOL, int *);
059ec3d9 268extern void receive_swallow_smtp(void);
8523533c
TK
269#ifdef WITH_CONTENT_SCAN
270extern int regex(uschar **);
271#endif
059ec3d9
PH
272extern BOOL regex_match_and_setup(const pcre *, uschar *, int, int);
273extern const pcre *regex_must_compile(uschar *, BOOL, BOOL);
274extern void retry_add_item(address_item *, uschar *, int);
275extern BOOL retry_check_address(uschar *, host_item *, uschar *, BOOL,
276 uschar **, uschar **);
277extern retry_config *retry_find_config(uschar *, uschar *, int, int);
ba9af0af
TF
278extern BOOL retry_ultimate_address_timeout(uschar *, uschar *,
279 dbdata_retry *, time_t);
059ec3d9
PH
280extern void retry_update(address_item **, address_item **, address_item **);
281extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
282extern uschar *rewrite_address_qualify(uschar *, BOOL);
283extern header_line *rewrite_header(header_line *, uschar *, uschar *,
284 rewrite_rule *, int, BOOL);
285extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
286 rewrite_rule *);
287extern void rewrite_test(uschar *);
288extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
289 uschar **);
290extern int route_address(address_item *, address_item **, address_item **,
291 address_item **, address_item **, int);
292extern int route_check_prefix(uschar *, uschar *);
293extern int route_check_suffix(uschar *, uschar *);
294extern BOOL route_findgroup(uschar *, gid_t *);
295extern BOOL route_finduser(uschar *, struct passwd **, uid_t *);
296extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
297 uschar **);
298extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
299 struct passwd **, uid_t *, uschar **);
300extern void route_init(void);
301extern void route_tidyup(void);
302
303extern uschar *search_find(void *, uschar *, uschar *, int, uschar *, int,
304 int, int *);
305extern int search_findtype(uschar *, int);
306extern int search_findtype_partial(uschar *, int *, uschar **, int *,
307 int *);
308extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
309extern void search_tidyup(void);
e0df1c83 310extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9
PH
311extern void sha1_end(sha1 *, const uschar *, int, uschar *);
312extern void sha1_mid(sha1 *, const uschar *);
313extern void sha1_start(sha1 *);
e4a89c47 314extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
efd9a422 315 uschar *, address_item **, uschar **);
059ec3d9 316extern void sigalrm_handler(int);
58eb016e 317extern BOOL smtp_buffered(void);
059ec3d9 318extern void smtp_closedown(uschar *);
9e4f5962 319extern int smtp_connect(host_item *, int, int, uschar *, int, BOOL, const uschar *);
059ec3d9
PH
320extern int smtp_feof(void);
321extern int smtp_ferror(void);
322extern uschar *smtp_get_connection_info(void);
323extern BOOL smtp_get_interface(uschar *, int, address_item *, BOOL *,
324 uschar **, uschar *);
325extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
326extern int smtp_getc(void);
327extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
b4ed4da0 328extern void smtp_log_no_mail(void);
4e88a19f 329extern void smtp_message_code(uschar **, int *, uschar **, uschar **);
059ec3d9 330extern BOOL smtp_read_response(smtp_inblock *, uschar *, int, int, int);
a5bd321b 331extern void smtp_respond(uschar *, int, BOOL, uschar *);
8f128379 332extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
059ec3d9
PH
333extern void smtp_send_prohibition_message(int, uschar *);
334extern int smtp_setup_msg(void);
335extern BOOL smtp_start_session(void);
336extern int smtp_ungetc(int);
d7b47fd0 337extern BOOL smtp_verify_helo(void);
e0df1c83 338extern int smtp_write_command(smtp_outblock *, BOOL, const char *, ...) PRINTF_FUNCTION(3,4);
8523533c
TK
339#ifdef WITH_CONTENT_SCAN
340extern int spam(uschar **);
8544e77a 341extern FILE *spool_mbox(unsigned long *, uschar *);
8523533c 342#endif
059ec3d9
PH
343extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
344extern BOOL spool_open_datafile(uschar *);
345extern int spool_open_temp(uschar *);
346extern int spool_read_header(uschar *, BOOL, BOOL);
347extern int spool_write_header(uschar *, int, uschar **);
348extern int stdin_getc(void);
349extern int stdin_feof(void);
350extern int stdin_ferror(void);
351extern int stdin_ungetc(int);
352extern uschar *string_append(uschar *, int *, int *, int, ...);
76146973 353extern uschar *string_append_listele(uschar *, uschar, const uschar *);
059ec3d9
PH
354extern uschar *string_base62(unsigned long int);
355extern uschar *string_cat(uschar *, int *, int *, const uschar *, int);
356extern uschar *string_copy_dnsdomain(uschar *);
357extern uschar *string_copy_malloc(uschar *);
358extern uschar *string_copylc(uschar *);
359extern uschar *string_copynlc(uschar *, int);
360extern uschar *string_dequote(uschar **);
81f91683 361extern BOOL string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4);
059ec3d9
PH
362extern uschar *string_format_size(int, uschar *);
363extern int string_interpret_escape(uschar **);
b1f8e4f8 364extern int string_is_ip_address(const uschar *, int *);
059ec3d9
PH
365extern uschar *string_log_address(address_item *, BOOL, BOOL);
366extern uschar *string_nextinlist(uschar **, int *, uschar *, int);
e0df1c83 367extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
059ec3d9 368extern uschar *string_printing2(uschar *, BOOL);
e28326d8 369extern uschar *string_split_message(uschar *);
c7396ac5 370extern uschar *string_unprinting(uschar *);
1ba28e2b
PP
371extern BOOL string_vformat(uschar *, int, const char *, va_list);
372extern int strcmpic(const uschar *, const uschar *);
373extern int strncmpic(const uschar *, const uschar *, int);
059ec3d9
PH
374extern uschar *strstric(uschar *, uschar *, BOOL);
375
376extern uschar *tod_stamp(int);
35aba663 377extern void tls_modify_variables(tls_support *);
059ec3d9
PH
378extern BOOL transport_check_waiting(uschar *, uschar *, int, uschar *,
379 BOOL *);
380extern void transport_init(void);
381extern BOOL transport_pass_socket(uschar *, uschar *, uschar *, uschar *,
382 int);
383extern uschar *transport_rcpt_address(address_item *, BOOL);
384extern BOOL transport_set_up_command(uschar ***, uschar *, BOOL, int,
385 address_item *, uschar *, uschar **);
386extern void transport_update_waiting(host_item *, uschar *);
387extern BOOL transport_write_block(int, uschar *, int);
1ba28e2b 388extern BOOL transport_write_string(int, const char *, ...);
511a6c14
JH
389extern BOOL transport_headers_send(address_item *, int, uschar *, uschar *,
390 BOOL (*)(int, uschar *, int, BOOL), BOOL, rewrite_rule *, int);
059ec3d9
PH
391extern BOOL transport_write_message(address_item *, int, int, int, uschar *,
392 uschar *, uschar *, uschar *, rewrite_rule *, int);
393extern void tree_add_duplicate(uschar *, address_item *);
394extern void tree_add_nonrecipient(uschar *);
395extern void tree_add_unusable(host_item *);
396extern int tree_insertnode(tree_node **, tree_node *);
397extern tree_node *tree_search(tree_node *, uschar *);
398extern void tree_write(tree_node *, FILE *);
38a0a95f 399extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
059ec3d9 400
8523533c
TK
401#ifdef WITH_CONTENT_SCAN
402extern void unspool_mbox(void);
403#endif
404
4deaf07d
PH
405extern int verify_address(address_item *, FILE *, int, int, int, int,
406 uschar *, uschar *, BOOL *);
059ec3d9 407extern int verify_check_dnsbl(uschar **);
4deaf07d 408extern int verify_check_header_address(uschar **, uschar **, int, int, int,
fe5b5d0b 409 uschar *, uschar *, int, int *);
059ec3d9 410extern int verify_check_headers(uschar **);
770747fd 411extern int verify_check_header_names_ascii(uschar **);
059ec3d9 412extern int verify_check_host(uschar **);
1c41c9cc 413extern int verify_check_notblind(void);
059ec3d9
PH
414extern int verify_check_this_host(uschar **, unsigned int *, uschar*,
415 uschar *, uschar **);
416extern address_item *verify_checked_sender(uschar *);
417extern void verify_get_ident(int);
418extern BOOL verify_sender(int *, uschar **);
419extern BOOL verify_sender_preliminary(int *, uschar **);
420extern void version_init(void);
421
17c76198
PP
422extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
423
059ec3d9 424/* End of functions.h */