diff.c: emit_diff_symbol learns DIFF_SYMBOL_NO_LF_EOF
[git.git] / Documentation / git-imap-send.txt
blob5d1e4c80cd5d479a43c39ffb12b66a7302e754e7
1 git-imap-send(1)
2 ================
4 NAME
5 ----
6 git-imap-send - Send a collection of patches from stdin to an IMAP folder
9 SYNOPSIS
10 --------
11 [verse]
12 'git imap-send' [-v] [-q] [--[no-]curl]
15 DESCRIPTION
16 -----------
17 This command uploads a mailbox generated with 'git format-patch'
18 into an IMAP drafts folder.  This allows patches to be sent as
19 other email is when using mail clients that cannot read mailbox
20 files directly. The command also works with any general mailbox
21 in which emails have the fields "From", "Date", and "Subject" in
22 that order.
24 Typical usage is something like:
26 git format-patch --signoff --stdout --attach origin | git imap-send
29 OPTIONS
30 -------
32 -v::
33 --verbose::
34         Be verbose.
36 -q::
37 --quiet::
38         Be quiet.
40 --curl::
41         Use libcurl to communicate with the IMAP server, unless tunneling
42         into it.  Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
43         option set.
45 --no-curl::
46         Talk to the IMAP server using git's own IMAP routines instead of
47         using libcurl.  Ignored if Git was built with the NO_OPENSSL option
48         set.
51 CONFIGURATION
52 -------------
54 To use the tool, imap.folder and either imap.tunnel or imap.host must be set
55 to appropriate values.
57 Variables
58 ~~~~~~~~~
60 imap.folder::
61         The folder to drop the mails into, which is typically the Drafts
62         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
63         "[Gmail]/Drafts". Required.
65 imap.tunnel::
66         Command used to setup a tunnel to the IMAP server through which
67         commands will be piped instead of using a direct network connection
68         to the server. Required when imap.host is not set.
70 imap.host::
71         A URL identifying the server. Use a `imap://` prefix for non-secure
72         connections and a `imaps://` prefix for secure connections.
73         Ignored when imap.tunnel is set, but required otherwise.
75 imap.user::
76         The username to use when logging in to the server.
78 imap.pass::
79         The password to use when logging in to the server.
81 imap.port::
82         An integer port number to connect to on the server.
83         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
84         Ignored when imap.tunnel is set.
86 imap.sslverify::
87         A boolean to enable/disable verification of the server certificate
88         used by the SSL/TLS connection. Default is `true`. Ignored when
89         imap.tunnel is set.
91 imap.preformattedHTML::
92         A boolean to enable/disable the use of html encoding when sending
93         a patch.  An html encoded patch will be bracketed with <pre>
94         and have a content type of text/html.  Ironically, enabling this
95         option causes Thunderbird to send the patch as a plain/text,
96         format=fixed email.  Default is `false`.
98 imap.authMethod::
99         Specify authenticate method for authentication with IMAP server.
100         If Git was built with the NO_CURL option, or if your curl version is older
101         than 7.34.0, or if you're running git-imap-send with the `--no-curl`
102         option, the only supported method is 'CRAM-MD5'. If this is not set
103         then 'git imap-send' uses the basic IMAP plaintext LOGIN command.
105 Examples
106 ~~~~~~~~
108 Using tunnel mode:
110 ..........................
111 [imap]
112     folder = "INBOX.Drafts"
113     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
114 ..........................
116 Using direct mode:
118 .........................
119 [imap]
120     folder = "INBOX.Drafts"
121     host = imap://imap.example.com
122     user = bob
123     pass = p4ssw0rd
124 .........................
126 Using direct mode with SSL:
128 .........................
129 [imap]
130     folder = "INBOX.Drafts"
131     host = imaps://imap.example.com
132     user = bob
133     pass = p4ssw0rd
134     port = 123
135     sslverify = false
136 .........................
139 EXAMPLE
140 -------
141 To submit patches using GMail's IMAP interface, first, edit your ~/.gitconfig
142 to specify your account settings:
144 ---------
145 [imap]
146         folder = "[Gmail]/Drafts"
147         host = imaps://imap.gmail.com
148         user = user@gmail.com
149         port = 993
150         sslverify = false
151 ---------
153 You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
154 that the "Folder doesn't exist".
156 Once the commits are ready to be sent, run the following command:
158   $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
160 Just make sure to disable line wrapping in the email client (GMail's web
161 interface will wrap lines no matter what, so you need to use a real
162 IMAP client).
164 CAUTION
165 -------
166 It is still your responsibility to make sure that the email message
167 sent by your email program meets the standards of your project.
168 Many projects do not like patches to be attached.  Some mail
169 agents will transform patches (e.g. wrap lines, send them as
170 format=flowed) in ways that make them fail.  You will get angry
171 flames ridiculing you if you don't check this.
173 Thunderbird in particular is known to be problematic.  Thunderbird
174 users may wish to visit this web page for more information:
175   http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
177 SEE ALSO
178 --------
179 linkgit:git-format-patch[1], linkgit:git-send-email[1], mbox(5)
183 Part of the linkgit:git[1] suite