summaryrefslogtreecommitdiffstats
path: root/doc/man/doveadm-import.1.in
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/man/doveadm-import.1.in142
1 files changed, 142 insertions, 0 deletions
diff --git a/doc/man/doveadm-import.1.in b/doc/man/doveadm-import.1.in
new file mode 100644
index 0000000..cec27e9
--- /dev/null
+++ b/doc/man/doveadm-import.1.in
@@ -0,0 +1,142 @@
+.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-IMPORT 1 "2015-08-09" "Dovecot v2.3" "Dovecot"
+.SH NAME
+doveadm\-import \- Import messages matching given search query
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " import " [" \-S
+.IR socket_path ]
+.RB [ \-U
+.IR source_user ]
+.RB [ \-s ]
+.I source_location dest_parent search_query
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " import " [" \-S
+.IR socket_path ]
+.RB [ \-U
+.IR source_user ]
+.RB [ \-s ]
+.BI \-A " source_location dest_parent search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " import " [" \-S
+.IR socket_path ]
+.RB [ \-s ]
+.BI \-F " file source_location dest_parent search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " import " [" \-S
+.IR socket_path ]
+.RB [ \-U
+.IR source_user ]
+.RB [ \-s ]
+.BI \-u " user source_location dest_parent search_query"
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+This command can be used to import mails from another mail storage specified by
+.I source_location
+to one or more user\(aqs mailboxes. All the mailboxes are imported under the
+given
+.I dest_parent
+mailbox, or to root level if
+.I dest_parent
+is empty (\(dq\(dq). The
+.I search_query
+can be used to restrict which mailboxes or messages are imported. By default
+the import is done in destination user's context, you can use \-U to change
+this.
+
+In the first form,
+.BR doveadm (1)
+will executed the
+.B import
+action with the environment of the logged in system user.
+.PP
+In the second form, the mails will be imported for all users.
+.PP
+In the third form, the mails will be imported for all users listed in the
+given
+.IR file .
+.PP
+In the fourth form, the mails will be imported only for given
+.IR user (s).
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-F-file@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+.TP
+.B \-s
+When the
+.B \-s
+option is present,
+.I dest_parent
+and all new mailboxes under it will be subscribed to.
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.TP
+.B \-U username
+When the
+.B \-U
+option is present, the source box is opened with given username.
+.SH ARGUMENTS
+.TP
+.I dest_parent
+The name of the destination mailbox, under which the mails should be
+imported.
+.BR doveadm (1)
+will create the
+.I dest_parent
+mailbox if it doesn\(aqt exist.
+.TP
+.I search_query
+Copy messages matching this search query.
+See
+.BR doveadm\-search\-query (7)
+for details.
+.TP
+.I source_location
+This argument specifies the mailbox format and location of the source
+location. The syntax is the same as for the
+.I mail_location
+setting.
+For example:
+.B maildir:/backup/20101126/jane.doe/Maildir
+or
+.B mdbox:/srv/mail/john.doe/mdbox:ALT=/nfsmount/john.doe/mdbox
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+This example imports all mails from a backup under a
+.I backup\-20101026
+mailbox:
+.PP
+.nf
+.B doveadm import \-u jane.doe@example.org \(rs
+.B mdbox:/backup/20101026/jane.doe/mdbox backup\-20101026 all
+.fi
+.PP
+Another example that imports only messages from foo@example.org in the
+backup mdbox\(aqs INBOX to jane\(aqs INBOX:
+.PP
+.nf
+.B doveadm import \-u jane.doe@example.org \(rs
+.B mdbox:~/mdbox\-backup \(dq\(dq mailbox INBOX from foo@example.org
+.fi
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-fetch (1),
+.BR doveadm\-search (1),
+.BR doveadm\-search\-query (7)