git-imap-send(1)

1GIT-IMAP-SEND(1)                  Git Manual                  GIT-IMAP-SEND(1)
2
3
4

NAME

6       git-imap-send - Send a collection of patches from stdin to an IMAP
7       folder
8

SYNOPSIS

10       git imap-send
11
12

DESCRIPTION

14       This command uploads a mailbox generated with git format-patch into an
15       IMAP drafts folder. This allows patches to be sent as other email is
16       when using mail clients that cannot read mailbox files directly. The
17       command also works with any general mailbox in which emails have the
18       fields "From", "Date", and "Subject" in that order.
19
20       Typical usage is something like:
21
22       git format-patch --signoff --stdout --attach origin | git imap-send
23

CONFIGURATION

25       To use the tool, imap.folder and either imap.tunnel or imap.host must
26       be set to appropriate values.
27
28   Variables
29       imap.folder
30           The folder to drop the mails into, which is typically the Drafts
31           folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
32           "[Gmail]/Drafts". Required to use imap-send.
33
34       imap.tunnel
35           Command used to setup a tunnel to the IMAP server through which
36           commands will be piped instead of using a direct network connection
37           to the server. Required when imap.host is not set to use imap-send.
38
39       imap.host
40           A URL identifying the server. Use a imap:// prefix for non-secure
41           connections and a imaps:// prefix for secure connections. Ignored
42           when imap.tunnel is set, but required to use imap-send otherwise.
43
44       imap.user
45           The username to use when logging in to the server.
46
47       imap.pass
48           The password to use when logging in to the server.
49
50       imap.port
51           An integer port number to connect to on the server. Defaults to 143
52           for imap:// hosts and 993 for imaps:// hosts. Ignored when
53           imap.tunnel is set.
54
55       imap.sslverify
56           A boolean to enable/disable verification of the server certificate
57           used by the SSL/TLS connection. Default is true. Ignored when
58           imap.tunnel is set.
59
60       imap.preformattedHTML
61           A boolean to enable/disable the use of html encoding when sending a
62           patch. An html encoded patch will be bracketed with <pre> and have
63           a content type of text/html. Ironically, enabling this option
64           causes Thunderbird to send the patch as a plain/text, format=fixed
65           email. Default is false.
66
67       imap.authMethod
68           Specify authenticate method for authentication with IMAP server.
69           Current supported method is CRAM-MD5 only.
70
71   Examples
72       Using tunnel mode:
73
74           [imap]
75               folder = "INBOX.Drafts"
76               tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
77
78       Using direct mode:
79
80           [imap]
81               folder = "INBOX.Drafts"
82               host = imap://imap.example.com
83               user = bob
84               pass = p4ssw0rd
85
86       Using direct mode with SSL:
87
88           [imap]
89               folder = "INBOX.Drafts"
90               host = imaps://imap.example.com
91               user = bob
92               pass = p4ssw0rd
93               port = 123
94               sslverify = false
95

EXAMPLE

97       To submit patches using GMail’s IMAP interface, first, edit your
98       ~/.gitconfig to specify your account settings:
99
100           [imap]
101                   folder = "[Gmail]/Drafts"
102                   host = imaps://imap.gmail.com
103                   user = user@gmail.com
104                   port = 993
105                   sslverify = false
106
107
108       You might need to instead use: folder = "[Google Mail]/Drafts" if you
109       get an error that the "Folder doesn’t exist".
110
111       Once the commits are ready to be sent, run the following command:
112
113           $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
114
115       Just make sure to disable line wrapping in the email client (GMail’s
116       web interface will wrap lines no matter what, so you need to use a real
117       IMAP client).
118

CAUTION

120       It is still your responsibility to make sure that the email message
121       sent by your email program meets the standards of your project. Many
122       projects do not like patches to be attached. Some mail agents will
123       transform patches (e.g. wrap lines, send them as format=flowed) in ways
124       that make them fail. You will get angry flames ridiculing you if you
125       don’t check this.
126
127       Thunderbird in particular is known to be problematic. Thunderbird users
128       may wish to visit this web page for more information:
129       http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
130

GIT

135       Part of the git(1) suite
136
137
138
139Git 1.8.3.1                       11/19/2018                  GIT-IMAP-SEND(1)