Google Git
Sign in
chromium / external / gitster / git-htmldocs / 4aa0bccc4a84ed806fa27aefcb79e56e508dc6c9 / . / git-imap-send.html
blob: e24e3ea6b707a840628b6e270afcf3e299cf779d [file] [log] [blame]
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]306</style>
307<title>git-imap-send(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-imap-send(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-imap-send -
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]317 Send a collection of patches from stdin to an IMAP folder
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]323<div class="para"><p><em>git imap-send</em></p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]326<div class="sectionbody">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]327<div class="para"><p>This command uploads a mailbox generated with <em>git format-patch</em>
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]328into an IMAP drafts folder. This allows patches to be sent as
329other email is when using mail clients that cannot read mailbox
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]330files directly.</p></div>
331<div class="para"><p>Typical usage is something like:</p></div>
332<div class="para"><p>git format-patch --signoff --stdout --attach origin | git imap-send</p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]333</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]334<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]335<div class="sectionbody">
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]336<div class="para"><p>To use the tool, imap.folder and either imap.tunnel or imap.host must be set
337to appropriate values.</p></div>
338<h3 id="_variables">Variables</h3><div style="clear:left"></div>
339<div class="vlist"><dl>
340<dt>
341imap.folder
342</dt>
343<dd>
344<p>
345 The folder to drop the mails into, which is typically the Drafts
346 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
347 "[Gmail]/Drafts". Required to use imap-send.
348</p>
349</dd>
350<dt>
351imap.tunnel
352</dt>
353<dd>
354<p>
355 Command used to setup a tunnel to the IMAP server through which
356 commands will be piped instead of using a direct network connection
357 to the server. Required when imap.host is not set to use imap-send.
358</p>
359</dd>
360<dt>
361imap.host
362</dt>
363<dd>
364<p>
365 A URL identifying the server. Use a <tt>imap://</tt> prefix for non-secure
366 connections and a <tt>imaps://</tt> prefix for secure connections.
367 Ignored when imap.tunnel is set, but required to use imap-send
368 otherwise.
369</p>
370</dd>
371<dt>
372imap.user
373</dt>
374<dd>
375<p>
376 The username to use when logging in to the server.
377</p>
378</dd>
379<dt>
Junio C Hamano4cfa5362009-04-18 23:01:01[diff] [blame]380imap.pass
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]381</dt>
382<dd>
383<p>
384 The password to use when logging in to the server.
385</p>
386</dd>
387<dt>
388imap.port
389</dt>
390<dd>
391<p>
392 An integer port number to connect to on the server.
393 Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
394 Ignored when imap.tunnel is set.
395</p>
396</dd>
397<dt>
398imap.sslverify
399</dt>
400<dd>
401<p>
402 A boolean to enable/disable verification of the server certificate
403 used by the SSL/TLS connection. Default is <tt>true</tt>. Ignored when
404 imap.tunnel is set.
405</p>
406</dd>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]407<dt>
408imap.preformattedHTML
409</dt>
410<dd>
411<p>
412 A boolean to enable/disable the use of html encoding when sending
413 a patch. An html encoded patch will be bracketed with &lt;pre&gt;
414 and have a content type of text/html. Ironically, enabling this
415 option causes Thunderbird to send the patch as a plain/text,
416 format=fixed email. Default is <tt>false</tt>.
417</p>
418</dd>
Junio C Hamano4aa0bcc2010-03-03 05:13:12[diff] [blame^]419<dt>
420imap.authMethod
421</dt>
422<dd>
423<p>
424 Specify authenticate method for authentication with IMAP server.
425 Current supported method is <em>CRAM-MD5</em> only.
426</p>
427</dd>
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]428</dl></div>
429<h3 id="_examples">Examples</h3><div style="clear:left"></div>
430<div class="para"><p>Using tunnel mode:</p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]431<div class="literalblock">
432<div class="content">
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]433<pre><tt>[imap]
Junio C Hamano5cf43ca2008-08-20 09:14:14[diff] [blame]434 folder = "INBOX.Drafts"
435 tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</tt></pre>
436</div></div>
437<div class="para"><p>Using direct mode:</p></div>
438<div class="literalblock">
439<div class="content">
440<pre><tt>[imap]
441 folder = "INBOX.Drafts"
442 host = imap://imap.example.com
443 user = bob
444 pass = p4ssw0rd</tt></pre>
445</div></div>
446<div class="para"><p>Using direct mode with SSL:</p></div>
447<div class="literalblock">
448<div class="content">
449<pre><tt>[imap]
450 folder = "INBOX.Drafts"
451 host = imaps://imap.example.com
452 user = bob
453 pass = p4ssw0rd
454 port = 123
455 sslverify = false</tt></pre>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]456</div></div>
457</div>
Junio C Hamanoec3b9a72009-02-13 08:45:52[diff] [blame]458<h2 id="_caution">CAUTION</h2>
459<div class="sectionbody">
460<div class="para"><p>It is still your responsibility to make sure that the email message
461sent by your email program meets the standards of your project.
462Many projects do not like patches to be attached. Some mail
463agents will transform patches (e.g. wrap lines, send them as
464format=flowed) in ways that make them fail. You will get angry
465flames ridiculing you if you don't check this.</p></div>
466<div class="para"><p>Thunderbird in particular is known to be problematic. Thunderbird
467users may wish to visit this web page for more information:
468 http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email</p></div>
469</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]470<h2 id="_bugs">BUGS</h2>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]471<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]472<div class="para"><p>Doesn't handle lines starting with "From " in the message body.</p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]473</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]474<h2 id="_author">Author</h2>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]475<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]476<div class="para"><p>Derived from isync 1.0.1 by Mike McCormack.</p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]477</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]478<h2 id="_documentation">Documentation</h2>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]479<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]480<div class="para"><p>Documentation by Mike McCormack</p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]481</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]482<h2 id="_git">GIT</h2>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]483<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]484<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]485</div>
486<div id="footer">
487<div id="footer-text">
Junio C Hamano4aa0bcc2010-03-03 05:13:12[diff] [blame^]488Last updated 2010-03-03 05:12:42 UTC
Junio C Hamano883d8432006-04-06 23:15:39[diff] [blame]489</div>
490</div>
491</body>
492</html>