1MAILDIRMAKE(1) Double Precision, Inc. MAILDIRMAKE(1)
2
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 -q quota
25 install a quota on the maildir. See maildirquota(7)[1], below.
26 -f folder
28 do not create a maildir, but create a folder in an existing
29 maildir.
30 -F folder
32 Like the -f option, except that the folder's name is given using
33 the system locale's character set. Non-Latin characters in the
34 folder's name must be given to the -f option using IMAP's
35 modified-UTF7 encoding. The -F option takes the folder name
36 specified using the console's character set..
37 -s mode
39 create a publicly accessible folder in an existing sharable
40 maildir. First, use the -S option to create a sharable maildir.
41 Then, run maildirmake again with the -s option to create publicly
42 accessible folders. mode is a comma-separated list of the
43 following keywords: read - readonly folder, only you can write
44 messages to this folder; write - anyone can read and write messages
45 to this folder; group - only allow members of your own system group
46 to access messages in this folder (instead of everyone).
47 --add name=pathname, --del name
49 create or delete the directories and links needed to access shared
50 folders. See below for more information.
51 FOLDERS
53 This maildirmake command supports enhanced maildirs that contain
54 folders.
55 By itself, maildirmake makes a new subdirectory maildir, and creates
57 all the necessary structures. The -f option creates a new "folder"
58 within an existing maildir. maildir must already exist, and the
59 maildirmake command will create a new folder in the maildir.
60 Folders are simply subdirectories inside the main maildir whose names
62 start with a period, and which are themselves maildirs. For example,
63 the command "maildirmake -f Drafts mail/Maildir" creates
64 mail/Maildir/.Drafts, that has the usual tmp, new and cur. You MUST use
65 the -f option, instead of specifying mail/Maildir/.Drafts directly, in
66 order to correctly initialize certain enhanced maildir features.
67 Folders cannot be created directly within other folders. Running
69 maildirmake -f Urgent mail/Maildir/.Drafts will not work. Instead, the
70 period character is designated as a hierarchy separator, run
71 maildirmake -f Drafts.Urgent mail/Maildir instead. This creates
72 mail/Maildir/.Drafts.Urgent, and all mail software that supports
73 enhanced maildirs will interpret it as a subfolder Urgent of the Drafts
74 folder.
75 SHARED FOLDERS
77 This is another extension to the Maildir format that allows folders to
78 be shared between multiple clients.
79 Note
81 The Courier IMAP server implements two types of shared folders:
82 filesystem permission-based shared folders, as well as virtual
83 shared folders based on IMAP access control lists. Use the
84 maildirmake command to implement shared folders based on filesystem
85 permissions. The maildiracl(1)[2] command manages access control
86 lists, which are used by virtual shared folders.
87 See the Courier IMAP server documentation for more information.
89 First, you need to create a collection of sharable folders, as a
91 separate maildir:
92 maildirmake -S /usr/local/share/maildirs/notices
94 Then, create individuals folders that will be accessed in shared mode:
96 maildirmake -s write -f Weekly /usr/local/share/maildirs/notices
98 In this example, the "Weekly" folder is created, with read/write access
100 to everyone. Multiple folders can be created in the same maildir, with
101 different access permissions. Everyone can create a sharable maildir.
102 The access privileges for individual folders are set by the -s option,
103 and are implemented using traditional filesystem permissions.
104 Use the --add and --del options to add a sharable maildir to an
106 existing maildir. Client software that implements this extension will
107 now know where to find sharable folders:
108 maildirmake --add notices=/usr/local/share/maildirs/notices $HOME/Maildir
110 $HOME/Maildir is your main maildir. The argument to -add is nick=path.
112 nick is a nickname for this collection of sharable folders, and path is
113 the location of the sharable maildir. All folders in the sharable
114 maildir that you have access to -- such as "Weekly", in this case, will
115 now be accessible. Multiple sharable maildirs can be added, by giving
116 each one a unique nick.
117 The --del option "disconnects" the sharable maildir from the main
119 maildir.
120 GLOBAL SHARED FOLDERS
122 Normally -add command must be run for every maildir which needs to
123 access the sharable maildir. Alternatively the file /etc/maildirshared
124 can be created, to specify a default set of sharable maildirs. Each
125 line in this file takes the following format:
126 nick<tab>path
128 nick is a short nickname for the sharable maildir, <tab> is a single
130 tab character, path is the pathname to the sharable maildir.
131 ACCESSING SHARED FOLDERS
133 You may have read or write access to a shared folder. If you have write
134 access, you can add messages to the shared folder. You can also delete
135 messages that you've added.
136 Anyone can create a sharable maildir, so if the sharable maildir is
138 actually created by you, can can delete any message, not just your own.
139
141 maildir(5)[3], maildiracl(1)[2], maildirkw(1)[4], maildrop(1)[5],
142 maildirquota(7)[1], deliverquota(8)[6], maildropfilter(7)[7],
143 http://www.qmail.org/man/man5/maildir.html.
144
146 Sam Varshavchik
147 Author
148
150 1. maildirquota(7)
151 [set $man.base.url.for.relative.links]/maildirquota.html
152 2. maildiracl(1)
154 [set $man.base.url.for.relative.links]/maildiracl.html
155 3. maildir(5)
157 [set $man.base.url.for.relative.links]/maildir.html
158 4. maildirkw(1)
160 [set $man.base.url.for.relative.links]/maildirkw.html
161 5. maildrop(1)
163 [set $man.base.url.for.relative.links]/maildrop.html
164 6. deliverquota(8)
166 [set $man.base.url.for.relative.links]/deliverquota.html
167 7. maildropfilter(7)
169 [set $man.base.url.for.relative.links]/maildropfilter.html
170Courier Mail Server 06/20/2015 MAILDIRMAKE(1)