Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-import.1.in @ 18927:e7cb20b4785a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: doveadm-import -s description updated The previously mentioned subscriptions-file is specific to Maildir format.
author Timo Sirainen <tss@iki.fi>
date Sun, 09 Aug 2015 21:54:33 +0300
parents c469d8f4cde7
children 0f22db71df7a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18137
3009a1a6f6d5 global: freshen copyright
Phil Carmody <phil@dovecot.fi>
parents: 17024
diff changeset
1 .\" Copyright (c) 2010-2015 Dovecot authors, see the included COPYING file
18927
e7cb20b4785a man: doveadm-import -s description updated
Timo Sirainen <tss@iki.fi>
parents: 18604
diff changeset
2 .TH DOVEADM\-IMPORT 1 "2015-08-09" "Dovecot v2.2" "Dovecot"
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
3 .SH NAME
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
4 doveadm\-import \- Import messages matching given search query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
6 .SH SYNOPSIS
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
7 .BR doveadm " [" \-Dv "] " import " [" \-S
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
8 .IR socket_path ]
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
9 .RB [ \-s ]
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
10 .I source_location dest_parent search_query
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
11 .br
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
12 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
13 .BR doveadm " [" \-Dv "] " import " [" \-S
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
14 .IR socket_path ]
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
15 .RB [ \-s ]
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
16 .BI \-A " source_location dest_parent search_query"
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
17 .br
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
18 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
19 .BR doveadm " [" \-Dv "] " import " [" \-S
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
20 .IR socket_path ]
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
21 .RB [ \-s ]
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
22 .BI \-F " file source_location dest_parent search_query"
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
23 .br
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
24 .\"-------------------------------------
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
25 .BR doveadm " [" \-Dv "] " import " [" \-S
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
26 .IR socket_path ]
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
27 .RB [ \-s ]
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
28 .BI \-u " user source_location dest_parent search_query"
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
29 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
30 .SH DESCRIPTION
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
31 This command can be used to import mails from another mail storage specified by
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
32 .I source_location
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
33 to one or more user\(aqs mailboxes. All the mailboxes are imported under the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
34 given
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
35 .I dest_parent
12462
16338d5462ba man: Make it clear that doveadm-import allows dest_parent to be ""
Timo Sirainen <tss@iki.fi>
parents: 12304
diff changeset
36 mailbox, or to root level if
16338d5462ba man: Make it clear that doveadm-import allows dest_parent to be ""
Timo Sirainen <tss@iki.fi>
parents: 12304
diff changeset
37 .I dest_parent
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
38 is empty (\(dq\(dq). The
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
39 .I search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
40 can be used to restrict which mailboxes or messages are imported.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
41
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
42 In the first form,
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
43 .BR doveadm (1)
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
44 will executed the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
45 .B import
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
46 action with the environment of the logged in system user.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
47 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
48 In the second form, the mails will be imported for all users.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
49 .PP
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
50 In the third form, the mails will be imported for all users listed in the
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
51 given
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
52 .IR file .
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
53 .PP
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
54 In the fourth form, the mails will be imported only for given
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
55 .IR user (s).
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
56 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
57 @INCLUDE:global-options@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
58 .\" --- command specific options --- "/.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
59 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
60 Command specific
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
61 .IR options :
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
62 .\"-------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
63 @INCLUDE:option-A@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
64 .\"-------------------------------------
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
65 @INCLUDE:option-F-file@
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
66 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
67 @INCLUDE:option-S-socket@
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
68 .\"-------------------------------------
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
69 .TP
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
70 .B \-s
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
71 When the
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
72 .B \-s
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
73 option is present,
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
74 .I dest_parent
18927
e7cb20b4785a man: doveadm-import -s description updated
Timo Sirainen <tss@iki.fi>
parents: 18604
diff changeset
75 and all new mailboxes under it will be subscribed to.
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
76 .\"-------------------------------------
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
77 @INCLUDE:option-u-user@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
78 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
79 .SH ARGUMENTS
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
80 .TP
12477
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
81 .I dest_parent
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
82 The name of the destination mailbox, under which the mails should be
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
83 imported.
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
84 .BR doveadm (1)
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
85 will create the
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
86 .I dest_parent
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
87 mailbox if it doesn\(aqt exist.
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
88 .TP
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
89 .I search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
90 Copy messages matching this search query.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
91 See
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
92 .BR doveadm\-search\-query (7)
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
93 for details.
12477
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
94 .TP
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
95 .I source_location
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
96 This argument specifies the mailbox format and location of the source
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
97 location. The syntax is the same as for the
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
98 .I mail_location
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
99 setting.
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
100 For example:
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
101 .B maildir:/backup/20101126/jane.doe/Maildir
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
102 or
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
103 .B mdbox:/srv/mail/john.doe/mdbox:ALT=/nfsmount/john.doe/mdbox
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
104 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
105 .SH EXAMPLE
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
106 This example imports all mails from a backup under a
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
107 .I backup\-20101026
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
108 mailbox:
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
109 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
110 .nf
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
111 .B doveadm import \-u jane.doe@example.org \(rs
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
112 .B mdbox:/backup/20101026/jane.doe/mdbox backup\-20101026 all
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
113 .fi
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
114 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
115 Another example that imports only messages from foo@example.org in the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
116 backup mdbox\(aqs INBOX to jane\(aqs INBOX:
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
117 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
118 .nf
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
119 .B doveadm import \-u jane.doe@example.org \(rs
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
120 .B mdbox:~/mdbox\-backup \(dq\(dq mailbox INBOX from foo@example.org
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
121 .fi
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
122 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
123 @INCLUDE:reporting-bugs@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
124 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
125 .SH SEE ALSO
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
126 .BR doveadm (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
127 .BR doveadm\-fetch (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
128 .BR doveadm\-search (1),
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
129 .BR doveadm\-search\-query (7)