about summary refs log tree commit diff
path: root/git-fetch-email.1
blob: 13d9487d421ec308f13a9b1062cd06db37a6251e (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
.Dd June  5, 2021
.Dt GIT-FETCH-EMAIL 1
.Os
.
.Sh NAME
.Nm git-fetch-email
.Nd fetch patches over IMAP
.
.Sh SYNOPSIS
.Nm git
.Cm fetch-email
.Op Fl HUaisv
.Op Fl C Ar cc
.Op Fl F Ar from
.Op Fl M Ar mailbox
.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
.Op Fl u Ar user
.Oo
.Fl Fl
.Ar args ...
.Oc
.
.Sh DESCRIPTION
The
.Nm
command is a wrapper around
.Xr imbox 1
using
.Xr git-config 1
and
.Xr git-credential 1 .
It fetches patches to be applied with
.Xr git-am 1 .
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl C Ar cc | Fl \-cc Ns = Ns Ar cc | Fl \-no-cc
Fetch patches with matching
.Cm Cc
headers.
The default is the value of
.Cm fetchemail.cc .
.
.It Fl F Ar from | Fl \-from Ns = Ns Ar from | Fl \-no-from
Fetch patches with matching
.Cm From
headers.
The default is the value of
.Cm fetchemail.from .
.
.It Fl H | Fl \-headers
Fetch only patch headers.
.
.It Fl M Ar mailbox | Fl \-move-to Ns = Ns Ar mailbox | Fl \-no-move-to
Move matching patches to
.Ar mailbox .
With
.Fl \-apply ,
only move patches if
.Xr git-am 1
is successful.
The default is the value of
.Cm fetchemail.moveTo .
.
.It Fl S Ar subject | Fl \-subject Ns = Ns Ar subject | Fl \-no-subject
Fetch patches with matching
.Cm Subject
headers.
The default is the value of
.Cm fetchemail.subject ,
or
.Ql [PATCH .
.
.It Fl T Ar to | Fl \-to Ns = Ns Ar to | Fl \-no-to
Fetch patches with matching
.Cm To
headers.
The default is the value of
.Cm fetchemail.to .
.
.It Fl U | Fl \-unseen | Fl \-no-unseen
Fetch only patches which are unseen.
The default is the value of
.Cm fetchemail.unseen .
.
.It Fl a | Fl \-apply
Apply patches with
.Xr git-am 1 .
The arguments
.Fl \-patch-format Ns = Ns mboxrd
are passed to
.Xr git-am 1
along with any arguments following
.Ql Fl \-
passed to
.Nm .
.
.It Fl h Ar host | Fl \-host Ns = Ns Ar host
Connect to IMAP on
.Ar host .
The default is the value of
.Cm fetchemail.imapServer ,
or as inferred by
.Xr imbox 1 .
.
.It Fl i | Fl \-idle
Wait for matching patches
using IMAP IDLE.
.
.It Fl m Ar mailbox | Fl \-mailbox Ns = Ns Ar mailbox
Fetch patches from
.Ar mailbox .
The default is the value of
.Cm fetchemail.imapMailbox ,
or INBOX.
.
.It Fl p Ar port | Fl \-port Ns = Ns Ar port
Connect to IMAP on
.Ar port .
The default is the value of
.Cm fetchemail.imapServerPort ,
or as inferred by
.Xr imbox 1 .
.
.It Fl s | Fl \-mark-seen | Fl \-no-mark-seen
Mark matching patches as seen.
With
.Fl \-apply ,
only mark patches if
.Xr git-am 1
is successful.
The default is the value of
.Cm fetchemail.markSeen .
.
.It Fl u Ar user | Fl \-user Ns = Ns Ar user
Log in to IMAP as
.Ar user .
The default is the value of
.Cm fetchemail.imapUser .
.
.It Fl v | Fl \-verbose
Log IMAP protocol to standard error.
.El
.
.Pp
If
.Cm fetchemail.imapPass
is set,
it is used as the IMAP login password,
otherwise the password is obtained using
.Xr git-credential 1 .
.
.Sh EXAMPLES
.Bd -literal
git config fetchemail.imapUser june@causal.agency
git config fetchemail.to list+imbox@causal.agency
git fetch-email --apply
.Ed
.
.Sh SEE ALSO
.Xr git-am 1 ,
.Xr imbox 1 ,
.Xr gitcredentials 7
.
.Sh AUTHORS
.An June McEnroe Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt list+imbox@causal.agency
or join
.Li #ascii.town
on
.Li irc.tilde.chat .