Expand the documentation about the new submission mode behaviour.
[exim.git] / src / src / transports / appendfile.h
1 /* $Cambridge: exim/src/src/transports/appendfile.h,v 1.2 2005/01/04 10:00:45 ph10 Exp $ */
2
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
6
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
8 /* See the file NOTICE for conditions of use and distribution. */
9
10 /* Private structure for the private options. */
11
12 typedef struct {
13 uschar *filename;
14 uschar *dirname;
15 uschar *dirfilename;
16 uschar *message_prefix;
17 uschar *message_suffix;
18 uschar *create_file_string;
19 uschar *quota;
20 uschar *quota_directory;
21 uschar *quota_filecount;
22 uschar *quota_size_regex;
23 uschar *quota_warn_threshold;
24 uschar *mailbox_size_string;
25 uschar *mailbox_filecount_string;
26 uschar *maildir_dir_regex;
27 uschar *maildir_tag;
28 uschar *mailstore_prefix;
29 uschar *mailstore_suffix;
30 uschar *check_string;
31 uschar *escape_string;
32 uschar *file_format;
33 int mailbox_size_value;
34 int mailbox_filecount_value;
35 int quota_value;
36 int quota_filecount_value;
37 int quota_warn_threshold_value;
38 int mode;
39 int dirmode;
40 int lockfile_mode;
41 int lockfile_timeout;
42 int lock_fcntl_timeout;
43 int lock_flock_timeout;
44 int lock_retries;
45 int lock_interval;
46 int maildir_retries;
47 int create_file;
48 int options;
49 BOOL allow_fifo;
50 BOOL allow_symlink;
51 BOOL check_group;
52 BOOL check_owner;
53 BOOL create_directory;
54 BOOL notify_comsat;
55 BOOL use_lockfile;
56 BOOL set_use_lockfile;
57 BOOL use_fcntl;
58 BOOL set_use_fcntl;
59 BOOL use_flock;
60 BOOL set_use_flock;
61 BOOL use_mbx_lock;
62 BOOL set_use_mbx_lock;
63 BOOL use_bsmtp;
64 BOOL use_crlf;
65 BOOL file_must_exist;
66 BOOL mode_fail_narrower;
67 BOOL maildir_format;
68 BOOL maildir_use_size_file;
69 BOOL mailstore_format;
70 BOOL mbx_format;
71 BOOL quota_warn_threshold_is_percent;
72 BOOL quota_is_inclusive;
73 } appendfile_transport_options_block;
74
75 /* Restricted creation options */
76
77 enum { create_anywhere, create_belowhome, create_inhome };
78
79 /* Data for reading the private options. */
80
81 extern optionlist appendfile_transport_options[];
82 extern int appendfile_transport_options_count;
83
84 /* Block containing default values. */
85
86 extern appendfile_transport_options_block appendfile_transport_option_defaults;
87
88 /* The main and init entry points for the transport */
89
90 extern BOOL appendfile_transport_entry(transport_instance *, address_item *);
91 extern void appendfile_transport_init(transport_instance *);
92
93 /* Function that is shared with tf_maildir.c */
94
95 extern int check_dir_size(uschar *, int *, const pcre *);
96
97 /* End of transports/appendfile.h */