Mercurial > dovecot > core-2.2
annotate doc/man/doveadm-import.1.in @ 16484:1f3f21081ee5
man pages: Updated v2.1 -> v2.2
author | Timo Sirainen <tss@iki.fi> |
---|---|
date | Sun, 09 Jun 2013 02:49:48 +0300 |
parents | a695e124e62f |
children | be86adfff0ca |
rev | line source |
---|---|
12304
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
1 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file |
16484
1f3f21081ee5
man pages: Updated v2.1 -> v2.2
Timo Sirainen <tss@iki.fi>
parents:
13707
diff
changeset
|
2 .TH DOVEADM\-IMPORT 1 "2010-11-26" "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 |
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
8 .IR socket_path "] " "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
|
9 .br |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
10 .\"------------------------------------- |
12471
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
11 .BR doveadm " [" \-Dv "] " import " [" \-S |
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
12 .IR socket_path "] " |
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
13 .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
|
14 .br |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
15 .\"------------------------------------- |
12471
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
16 .BR doveadm " [" \-Dv "] " import " [" \-S |
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
17 .IR socket_path "] " |
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
18 .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
|
19 .\"------------------------------------------------------------------------ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
20 .SH DESCRIPTION |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
21 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
|
22 .I source_location |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
23 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
|
24 given |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
25 .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
|
26 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
|
27 .I dest_parent |
12464
464fe0e62078
man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents:
12462
diff
changeset
|
28 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
|
29 .I search_query |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
30 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
|
31 |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
32 In the first form, |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
33 .BR doveadm (1) |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
34 will executed the |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
35 .B import |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
36 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
|
37 .PP |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
38 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
|
39 .PP |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
40 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
|
41 .IR user (s). |
12304
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
42 .\"------------------------------------------------------------------------ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
43 @INCLUDE:global-options@ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
44 .\" --- command specific options --- "/. |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
45 .PP |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
46 Command specific |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
47 .IR options : |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
48 .\"------------------------------------- |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
49 @INCLUDE:option-A@ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
50 .\"------------------------------------- |
12471
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
51 @INCLUDE:option-S-socket@ |
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
52 .\"------------------------------------- |
12304
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
53 @INCLUDE:option-u-user@ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
54 .\"------------------------------------------------------------------------ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
55 .SH ARGUMENTS |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
56 .TP |
12477
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
57 .I dest_parent |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
58 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
|
59 imported. |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
60 .BR doveadm (1) |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
61 will create the |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
62 .I dest_parent |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
63 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
|
64 .TP |
12304
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
65 .I search_query |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
66 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
|
67 See |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
68 .BR doveadm\-search\-query (7) |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
69 for details. |
12477
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
70 .TP |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
71 .I source_location |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
72 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
|
73 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
|
74 .I mail_location |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
75 setting. |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
76 For example: |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
77 .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
|
78 or |
9e54d61d57fb
man: doveadm-import.1: Added missing argument descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents:
12471
diff
changeset
|
79 .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
|
80 .\"------------------------------------------------------------------------ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
81 .SH EXAMPLE |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
82 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
|
83 .I backup\-20101026 |
12304
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
84 mailbox: |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
85 .PP |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
86 .nf |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
87 .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
|
88 .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
|
89 .fi |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
90 .PP |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
91 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
|
92 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
|
93 .PP |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
94 .nf |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
95 .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
|
96 .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
|
97 .fi |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
98 .\"------------------------------------------------------------------------ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
99 @INCLUDE:reporting-bugs@ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
100 .\"------------------------------------------------------------------------ |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
101 .SH SEE ALSO |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
102 .BR doveadm (1), |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
103 .BR doveadm\-fetch (1), |
6c2d5ed0b664
doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff
changeset
|
104 .BR doveadm\-search (1), |
12471
fee02c0565e7
man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents:
12464
diff
changeset
|
105 .BR doveadm\-search\-query (7) |