1MAILDIRMAKE(1) Double Precision, Inc. MAILDIRMAKE(1)
2
3
4
6 maildirmake - create maildirs and maildir folders
7
9 maildirmake [options...] {maildir}
10
12 The maildirmake command creates maildirs, and maildir folders. This
13 documentation describes the maildirmake command from the Courier mail
14 server, which creates an extended form of maildirs that implements
15 additional extensions beyond the basic maildir properties that were
16 first implemented in the Qmail mail server.
17
19 -S
20 create a "sharable" maildir. A sharable maildir has slightly
21 different permissions which allows creation of publicly-shared
22 folders.
23
24 -q quota
25 install a quota on the maildir. See maildirquota(7)[1], below.
26
27 -f folder
28 do not create a maildir, but create a folder in an existing
29 maildir.
30
31 -s mode
32 create a publicly accessible folder in an existing sharable
33 maildir. First, use the -S option to create a sharable maildir.
34 Then, run maildirmake again with the -s option to create publicly
35 accessible folders. mode is a comma-separated list of the
36 following keywords: read - readonly folder, only you can write
37 messages to this folder; write - anyone can read and write messages
38 to this folder; group - only allow members of your own system group
39 to access messages in this folder (instead of everyone).
40
41 --add name=pathname, --del name
42 create or delete the directories and links needed to access shared
43 folders. See below for more information.
44
45 FOLDERS
46 This maildirmake command supports enhanced maildirs that contain
47 folders.
48
49 By itself, maildirmake makes a new subdirectory maildir, and creates
50 all the necessary structures. The -f option creates a new "folder"
51 within an existing maildir. maildir must already exist, and the
52 maildirmake command will create a new folder in the maildir.
53
54 Folders are simply subdirectories inside the main maildir whose names
55 start with a period, and which are themselves maildirs. For example,
56 the command "maildirmake -f Drafts mail/Maildir" creates
57 mail/Maildir/.Drafts, that has the usual tmp, new and cur. You MUST use
58 the -f option, instead of specifying mail/Maildir/.Drafts directly, in
59 order to correctly initialize certain enhanced maildir features.
60
61 Folders cannot be created directly within other folders. Running
62 maildirmake -f Urgent mail/Maildir/.Drafts will not work. Instead, the
63 period character is designated as a hierarchy separator, run
64 maildirmake -f Drafts.Urgent mail/Maildir instead. This creates
65 mail/Maildir/.Drafts.Urgent, and all mail software that supports
66 enhanced maildirs will interpret it as a subfolder Urgent of the Drafts
67 folder.
68
69 SHARED FOLDERS
70 This is another extension to the Maildir format that allows folders to
71 be shared between multiple clients.
72
73 Note
74 The Courier IMAP server implements two types of shared folders:
75 filesystem permission-based shared folders, as well as virtual
76 shared folders based on IMAP access control lists. Use the
77 maildirmake command to implement shared folders based on filesystem
78 permissions. The maildiracl(1)[2] command manages access control
79 lists, which are used by virtual shared folders.
80
81 See the Courier IMAP server documentation for more information.
82
83 First, you need to create a collection of sharable folders, as a
84 separate maildir:
85
86 Then, create individuals folders that will be accessed in shared mode:
87
88 In this example, the "Weekly" folder is created, with read/write access
89 to everyone. Multiple folders can be created in the same maildir, with
90 different access permissions. Everyone can create a sharable maildir.
91 The access privileges for individual folders are set by the -s option,
92 and are implemented using traditional filesystem permissions.
93
94 Use the --add and --del options to add a sharable maildir to an
95 existing maildir. Client software that implements this extension will
96 now know where to find sharable folders:
97
98 $HOME/Maildir is your main maildir. The argument to -add is nick=path.
99 nick is a nickname for this collection of sharable folders, and path is
100 the location of the sharable maildir. All folders in the sharable
101 maildir that you have access to -- such as "Weekly", in this case, will
102 now be accessible. Multiple sharable maildirs can be added, by giving
103 each one a unique nick.
104
105 The --del option "disconnects" the sharable maildir from the main
106 maildir.
107
108 GLOBAL SHARED FOLDERS
109 Normally -add command must be run for every maildir which needs to
110 access the sharable maildir. Alternatively the file /etc/maildirshared
111 can be created, to specify a default set of sharable maildirs. Each
112 line in this file takes the following format:
113
114 nick is a short nickname for the sharable maildir, <tab> is a single
115 tab character, path is the pathname to the sharable maildir.
116
117 ACCESSING SHARED FOLDERS
118 You may have read or write access to a shared folder. If you have write
119 access, you can add messages to the shared folder. You can also delete
120 messages that you´ve added.
121
122 Anyone can create a sharable maildir, so if the sharable maildir is
123 actually created by you, can can delete any message, not just your own.
124
126 maildir(5)[3], maildiracl(1)[2], maildirkw(1)[4], maildrop(1)[5],
127 maildirquota(7)[1], deliverquota(8)[6], maildropfilter(7)[7],
128 http://www.qmail.org/man/man5/maildir.html.
129
131 1. maildirquota(7)
132 [set $man.base.url.for.relative.links]/maildirquota.html
133
134 2. maildiracl(1)
135 [set $man.base.url.for.relative.links]/maildiracl.html
136
137 3. maildir(5)
138 [set $man.base.url.for.relative.links]/maildir.html
139
140 4. maildirkw(1)
141 [set $man.base.url.for.relative.links]/maildirkw.html
142
143 5. maildrop(1)
144 [set $man.base.url.for.relative.links]/maildrop.html
145
146 6. deliverquota(8)
147 [set $man.base.url.for.relative.links]/deliverquota.html
148
149 7. maildropfilter(7)
150 [set $man.base.url.for.relative.links]/maildropfilter.html
151
152
153
154Double Precision, Inc. 02/19/2010 MAILDIRMAKE(1)