Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-import.1.in @ 18137:3009a1a6f6d5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
global: freshen copyright Robomatically: git ls-files | xargs perl -p -i -e 's/(\d+)-201[0-4]/$1-2015/g;s/ (201[0-4]) Dovecot/ $1-2015 Dovecot/' Happy 2015 everyone! Signed-off-by: Phil Carmody <phil@dovecot.fi>
author Phil Carmody <phil@dovecot.fi>
date Mon, 05 Jan 2015 22:20:10 +0200
parents be86adfff0ca
children c469d8f4cde7
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
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
2 .TH DOVEADM\-IMPORT 1 "2013-11-24" "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 ]
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
22 .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
23 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
24 .SH DESCRIPTION
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
25 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
26 .I source_location
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
27 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
28 given
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
29 .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
30 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
31 .I dest_parent
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
32 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
33 .I search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
34 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
35
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
36 In the first form,
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
37 .BR doveadm (1)
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
38 will executed the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
39 .B import
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
40 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
41 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
42 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
43 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
44 In the third 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
45 .IR user (s).
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
46 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
47 @INCLUDE:global-options@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
48 .\" --- command specific options --- "/.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
49 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
50 Command specific
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
51 .IR options :
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
52 .\"-------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
53 @INCLUDE:option-A@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
54 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
55 @INCLUDE:option-S-socket@
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
56 .\"-------------------------------------
17024
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
57 .TP
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
58 .B \-s
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
59 When the
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
60 .B \-s
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
61 option is present,
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
62 .I dest_parent
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
63 and all new mailboxes under it will be listed in the
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
64 .I subscriptions
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
65 file.
be86adfff0ca man: doveadm-import.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
66 .\"-------------------------------------
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
67 @INCLUDE:option-u-user@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
68 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
69 .SH ARGUMENTS
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
70 .TP
12477
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
71 .I dest_parent
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
72 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
73 imported.
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
74 .BR doveadm (1)
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
75 will create the
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
76 .I dest_parent
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
77 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
78 .TP
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
79 .I search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
80 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
81 See
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
82 .BR doveadm\-search\-query (7)
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
83 for details.
12477
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
84 .TP
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
85 .I source_location
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
86 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
87 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
88 .I mail_location
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
89 setting.
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
90 For example:
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
91 .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
92 or
9e54d61d57fb man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
93 .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
94 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
95 .SH EXAMPLE
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
96 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
97 .I backup\-20101026
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
98 mailbox:
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
99 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
100 .nf
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
101 .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
102 .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
103 .fi
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
104 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
105 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
106 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
107 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
108 .nf
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
109 .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
110 .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
111 .fi
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
112 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
113 @INCLUDE:reporting-bugs@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
114 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
115 .SH SEE ALSO
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
116 .BR doveadm (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
117 .BR doveadm\-fetch (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
118 .BR doveadm\-search (1),
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 12464
diff changeset
119 .BR doveadm\-search\-query (7)