← Back to branch summary

~ubuntu-branches/ubuntu/wily/dovecot/wily

« back to all changes in this revision

Viewing changes to doc/man/doveadm-flags.1.in

  • Committer: Package Import Robot
  • Author(s): Jaldhar H. Vyas
  • Date: 2013-09-09 00:57:32 UTC
  • mfrom: (1.13.11)
  • mto: (4.8.5 experimental) (1.16.1)
  • mto: This revision was merged to the branch mainline in revision 97.
  • Revision ID: package-import@ubuntu.com-20130909005732-dn1eell8srqbhh0e
Tags: upstream-2.2.5
Import upstream version 2.2.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/doveadm-flags.1.in
 
1
.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
 
2
.TH DOVEADM\-FLAGS 1 "2013-08-02" "Dovecot v2.2" "Dovecot"
 
3
.SH NAME
 
4
doveadm\-flags \- add, remove or replace messages\(aq flags
 
5
.\"------------------------------------------------------------------------
 
6
.SH SYNOPSIS
 
7
.BR doveadm " [" \-Dv "] " flags " [" \-S
 
8
.IR socket_path "] " "command flags search_query"
 
9
.\"-------------------------------------
 
10
.br
 
11
.BR doveadm " [" \-Dv "] " flags " [" \-S
 
12
.IR socket_path "] " "command flags search_query"
 
13
.B \-A
 
14
.\"-------------------------------------
 
15
.br
 
16
.BR doveadm " [" \-Dv "] " flags " [" \-S
 
17
.IR socket_path "] " "command flags search_query"
 
18
.BI "\-u " user
 
19
.\"------------------------------------------------------------------------
 
20
.SH DESCRIPTION
 
21
This command is used to manipulate flags of messages.
 
22
.\"------------------------------------------------------------------------
 
23
@INCLUDE:global-options@
 
24
.\"-------------------------------------
 
25
.PP
 
26
Command specific
 
27
.IR options :
 
28
.\"-------------------------------------
 
29
@INCLUDE:option-A@
 
30
.\"-------------------------------------
 
31
@INCLUDE:option-S-socket@
 
32
.\"-------------------------------------
 
33
@INCLUDE:option-u-user@
 
34
.\"------------------------------------------------------------------------
 
35
.SH ARGUMENTS
 
36
.TP
 
37
.I flags
 
38
Message flags as described in RFC 3501, section 2.3.2 (Flags Message
 
39
Attribute):
 
40
.BR \(rsAnswered ", " \(rsDeleted ", " \(rsDraft ", " \(rsFlagged ", "
 
41
.BR \(rsRecent " and " \(rsSeen .
 
42
And the IMAP keywords
 
43
.BR \(DoForwarded ", " \(DoMDNSent ", " \(DoSubmitPending " and "
 
44
.B \(DoSubmitted
 
45
or user\-defined keywords, e.g. Junk, \(DoNonSpam or \(DoLabel1.
 
46
.br
 
47
One or multiple flags and/or keywords can be specified.
 
48
.\"-------------------------------------
 
49
.TP
 
50
.I search_query
 
51
Manipulate the flags of messages matching the given search query.
 
52
See
 
53
.BR doveadm\-search\-query (7)
 
54
for details.
 
55
.\"------------------------------------------------------------------------
 
56
.SH COMMANDS
 
57
.SS flags add
 
58
.BR "doveadm flags add" " [" \-u
 
59
.IR user |\c
 
60
.BR \-A "] [" \-S
 
61
.IR socket_path "] " "flags search_query"
 
62
.PP
 
63
This command is used to extend the current set of flags with the given
 
64
.IR flags .
 
65
.\"-------------------------------------
 
66
.SS flags remove
 
67
.BR "doveadm flags remove" " [" \-u
 
68
.IR user |\c
 
69
.BR \-A "] [" \-S
 
70
.IR socket_path "] " "flags search_query"
 
71
.PP
 
72
In order to remove the given
 
73
.I flags
 
74
from the current set of flags, use this command.
 
75
.\"-------------------------------------
 
76
.SS flags replace
 
77
.BR "doveadm flags replace" " [" \-u
 
78
.IR user |\c
 
79
.BR \-A "] [" \-S
 
80
.IR socket_path "] " "flags search_query"
 
81
.PP
 
82
This command is used to replace ALL current flags with the given
 
83
.IR flags .
 
84
.\"------------------------------------------------------------------------
 
85
.SH EXAMPLE
 
86
List and manipulate the message flags of the message with uid 81563
 
87
.sp
 
88
.nf
 
89
.B doveadm fetch \-u bob \(aquid flags\(aq mailbox dovecot uid 81563
 
90
uid: 81563
 
91
flags: \(rsAnswered \(rsSeen NonJunk
 
92
 
 
93
.B doveadm flags \-u bob remove NonJunk mailbox dovecot uid 81563
 
94
.B doveadm flags \-u bob add \(aq\(rsFlagged \(DoForwarded\(aq \
 
95
mailbox dovecot uid 81563
 
96
.fi
 
97
.\"------------------------------------------------------------------------
 
98
@INCLUDE:reporting-bugs@
 
99
.\"------------------------------------------------------------------------
 
100
.SH SEE ALSO
 
101
.BR doveadm (1),
 
102
.BR doveadm\-fetch (1),
 
103
.BR doveadm\-search\-query (7)
 
 
b'\\ No newline at end of file'