about summary refs log tree commit diff
path: root/imbox.1
blob: 1d3d648437510c4ade2ddc99ce99a20b49bc8942 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
.Dd December 23, 2019
.Dt IMBOX 1
.Os
.
.Sh NAME
.Nm imbox
.Nd IMAP to mbox
.
.Sh SYNOPSIS
.Nm
.Op Fl vw
.Op Fl C Ar cc
.Op Fl F Ar from
.Op Fl S Ar subject
.Op Fl T Ar to
.Op Fl h Ar host
.Op Fl m Ar mailbox
.Op Fl p Ar port
.Ar user
.
.Sh DESCRIPTION
The
.Nm
utility exports messages from an IMAP mailbox
to the mboxrd format on standard output.
Messages matching the criteria set by
.Fl CFST
are exported.
The default criterion is
.Fl S Cm '[PATCH' .
.
.Pp
IMAP over TLS without STARTTLS is assumed.
IMAP login is performed as
.Ar user
with a password read from
.Pa /dev/tty ,
or standard input if
.Fl w
is used.
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl C Ar cc
Export messages with matching
.Cm Cc
headers.
.
.It Fl F Ar from
Export messages with matching
.Cm From
headers.
.
.It Fl S Ar subject
Export messages with matching
.Cm Subject
headers.
.
.It Fl T Ar to
Export messages with matching
.Cm To
headers.
.
.It Fl h Ar host
Connect to IMAP on
.Ar host .
The default host is determined by SRV record lookup
on the domain name of
.Ar user ,
or simply the domain name
if no SRV record exists.
Lookup requires
.Xr dig 1 .
.
.It Fl m Ar mailbox
Export messages from
.Ar mailbox .
The default mailbox is INBOX.
.
.It Fl p Ar port
Connect to IMAP on
.Ar port .
If the
.Fl h
option is used,
the default port is
.Cm imaps
(993).
Otherwise,
the port is determined in the same fashion as the host.
.
.It Fl v
Log IMAP protocol to standard error.
.
.It Fl w
Read the password from standard input.
.El
.
.Sh EXAMPLES
.Bd -literal
imbox -T list@example.org june@causal.agency | git am
.Ed
.
.Sh SEE ALSO
.Xr git-am 1 ,
.Xr git-fetch-email 1
.
.Sh STANDARDS
.Bl -item
.It
.Rs
.%A M. Crispin
.%Q University of Washington
.%T INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1
.%I IETF
.%N RFC 3501
.%D March 2003
.%U https://tools.ietf.org/html/rfc3501
.Re
.It
.Rs
.%A E. Hall
.%T The application/mbox Media Type
.%I IETF
.%N RFC 4155
.%D September 2005
.%U https://tools.ietf.org/html/rfc4155
.Re
.El
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh CAVEATS
The
.Nm
utility only exports plain-text messages.
.
.Sh BUGS
Send mail to
.Aq Mt june@causal.agency
or join
.Li #ascii.town
on
.Li chat.freenode.net .