view doc/man/doveadm-purge.1.in @ 22644:2ed6735ffc7a

director: Change request callback to take mail_host parameter This allows accessing the IP address both as struct and as string without any conversions.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Sat, 04 Nov 2017 02:05:26 +0200
parents 2e2563132d5f
children cb108f786fb4
line wrap: on
line source

.\" Copyright (c) 2010-2017 Dovecot authors, see the included COPYING file
.TH DOVEADM\-PURGE 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-purge \- Remove messages with refcount=0 from mdbox files
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.BR doveadm " [" \-Dv "] " purge " [" \-S
.IR socket_path "] "
.\"-------------------------------------
.br
.BR doveadm " [" \-Dv "] " purge " [" \-S
.IR socket_path ]
.B \-A
.\"-------------------------------------
.br
.BR doveadm " [" \-Dv "] " purge " [" \-S
.IR socket_path ]
.BI \-F\  file
.\"-------------------------------------
.br
.BR doveadm " [" \-Dv "] " purge " [" \-S
.IR socket_path "] "
.BI \-u \ user
.\"------------------------------------------------------------------------
.SH DESCRIPTION
The
.B doveadm purge
command is used to remove all messages with refcount=0 from a user\(aqs
mail storage.
The refcount of a message is decreased to 0 when the user (or some
administration utility) has expunged all instances of a message from all
mailboxes.
.PP
In the first form,
.BR doveadm (1)
will perform the
.B purge
action for the currently logged in user.
.PP
In the second form, the command will be executed for all users.
.PP
In the third form, the command will be executed for all users listed in
the given
.IR file .
.PP
In the last form, only messages of the given
.IR user (s)
will be purged.
.\"------------------------------------------------------------------------
@INCLUDE:global-options@
.\" --- command specific options --- "/.
.PP
Command specific
.IR options :
.\"-------------------------------------
@INCLUDE:option-A@
.\"-------------------------------------
@INCLUDE:option-F-file@
.\"-------------------------------------
@INCLUDE:option-S-socket@
.\"-------------------------------------
@INCLUDE:option-u-user@
.\"------------------------------------------------------------------------
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH SEE ALSO
.BR doveadm (1),
.BR doveadm\-expunge (1)
.PP
See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi\-dbox for some
details.