git-imap-send.html - external/gitster/git-htmldocs - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta name="generator" content="AsciiDoc 8.2.5" />
 <style type="text/css">
 /* Debug borders */
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
 /*
  border: 1px solid red;
 */
 }

 body {
  margin: 1em 5% 1em 5%;
 }

 a {
  color: blue;
  text-decoration: underline;
 }
 a:visited {
  color: fuchsia;
 }

 em {
  font-style: italic;
 }

 strong {
  font-weight: bold;
 }

 tt {
  color: navy;
 }

 h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
 }

 h1, h2, h3 {
  border-bottom: 2px solid silver;
 }
 h2 {
  padding-top: 0.5em;
 }
 h3 {
  float: left;
 }
 h3 + * {
  clear: left;
 }

 div.sectionbody {
  font-family: serif;
  margin-left: 0;
 }

 hr {
  border: 1px solid silver;
 }

 p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
 }

 pre {
  padding: 0;
  margin: 0;
 }

 span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.1em;
 }
 span#email {
 }
 span#revision {
  font-family: sans-serif;
 }

 div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
 }
 div#footer-text {
  float: left;
  padding-bottom: 0.5em;
 }
 div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
 }

 div#preamble,
 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 div.admonitionblock {
  margin-right: 10%;
  margin-top: 1.5em;
  margin-bottom: 1.5em;
 }
 div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
 }

 div.content { /* Block element content. */
  padding: 0;
 }

 /* Block element titles. */
 div.title, caption.title {
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
 }
 div.title + * {
  margin-top: 0;
 }

 td div.title:first-child {
  margin-top: 0.0em;
 }
 div.content div.title:first-child {
  margin-top: 0.0em;
 }
 div.content + div.title {
  margin-top: 0.0em;
 }

 div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }

 div.listingblock {
  margin-right: 0%;
 }
 div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock > div.content {
  padding-left: 2.0em;
 }

 div.attribution {
  text-align: right;
 }
 div.verseblock + div.attribution {
  text-align: left;
 }

 div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
 }
 div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 2px solid silver;
 }

 div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
 }

 div.verseblock div.content {
  white-space: pre;
 }

 div.imageblock div.content { padding-left: 0; }
 div.imageblock img { border: 1px solid silver; }
 span.image img { border-style: none; }

 dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: italic;
 }
 dd > *:first-child {
  margin-top: 0;
 }

 ul, ol {
  list-style-position: outside;
 }
 div.olist2 ol {
  list-style-type: lower-alpha;
 }

 div.tableblock > table {
  border: 3px solid #527bbd;
 }
 thead {
  font-family: sans-serif;
  font-weight: bold;
 }
 tfoot {
  font-weight: bold;
 }

 div.hlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 div.hlist td {
  padding-bottom: 5px;
 }
 td.hlist1 {
  vertical-align: top;
  font-style: italic;
  padding-right: 0.8em;
 }
 td.hlist2 {
  vertical-align: top;
 }

 @media print {
  div#footer-badges { display: none; }
 }

 div#toctitle {
  color: #527bbd;
  font-family: sans-serif;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
 }

 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
 }
 div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
 }
 div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
 }
 div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
 }
 include1::./stylesheets/xhtml11-manpage.css[]
 /* Workarounds for IE6's broken and incomplete CSS2. */

 div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }
 div.sidebar-title, div.image-title {
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
 }

 div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock-content {
  padding-left: 2.0em;
 }

 div.exampleblock-content {
  border-left: 2px solid silver;
  padding-left: 0.5em;
 }

 /* IE6 sets dynamically generated links as visited. */
 div#toc a:visited { color: blue; }
 </style>
 <title>git-imap-send(1)</title>
 </head>
 <body>
 <div id="header">
 <h1>
 git-imap-send(1) Manual Page
 </h1>
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>git-imap-send -
  Send a collection of patches from stdin to an IMAP folder
 </p>
 </div>
 </div>
 <h2>SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="para"><p><em>git imap-send</em></p></div>
 </div>
 <h2 id="_description">DESCRIPTION</h2>
 <div class="sectionbody">
 <div class="para"><p>This command uploads a mailbox generated with <em>git-format-patch</em>
 into an IMAP drafts folder. This allows patches to be sent as
 other email is when using mail clients that cannot read mailbox
 files directly.</p></div>
 <div class="para"><p>Typical usage is something like:</p></div>
 <div class="para"><p>git format-patch --signoff --stdout --attach origin | git imap-send</p></div>
 </div>
 <h2 id="_configuration">CONFIGURATION</h2>
 <div class="sectionbody">
 <div class="para"><p>To use the tool, imap.folder and either imap.tunnel or imap.host must be set
 to appropriate values.</p></div>
 <h3 id="_variables">Variables</h3><div style="clear:left"></div>
 <div class="vlist"><dl>
 <dt>
 imap.folder
 </dt>
 <dd>
 <p>
  The folder to drop the mails into, which is typically the Drafts
  folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
  "[Gmail]/Drafts". Required to use imap-send.
 </p>
 </dd>
 <dt>
 imap.tunnel
 </dt>
 <dd>
 <p>
  Command used to setup a tunnel to the IMAP server through which
  commands will be piped instead of using a direct network connection
  to the server. Required when imap.host is not set to use imap-send.
 </p>
 </dd>
 <dt>
 imap.host
 </dt>
 <dd>
 <p>
  A URL identifying the server. Use a <tt>imap://</tt> prefix for non-secure
  connections and a <tt>imaps://</tt> prefix for secure connections.
  Ignored when imap.tunnel is set, but required to use imap-send
  otherwise.
 </p>
 </dd>
 <dt>
 imap.user
 </dt>
 <dd>
 <p>
  The username to use when logging in to the server.
 </p>
 </dd>
 <dt>
 imap.pass
 </dt>
 <dd>
 <p>
  The password to use when logging in to the server.
 </p>
 </dd>
 <dt>
 imap.port
 </dt>
 <dd>
 <p>
  An integer port number to connect to on the server.
  Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
  Ignored when imap.tunnel is set.
 </p>
 </dd>
 <dt>
 imap.sslverify
 </dt>
 <dd>
 <p>
  A boolean to enable/disable verification of the server certificate
  used by the SSL/TLS connection. Default is <tt>true</tt>. Ignored when
  imap.tunnel is set.
 </p>
 </dd>
 <dt>
 imap.preformattedHTML
 </dt>
 <dd>
 <p>
  A boolean to enable/disable the use of html encoding when sending
  a patch. An html encoded patch will be bracketed with &lt;pre&gt;
  and have a content type of text/html. Ironically, enabling this
  option causes Thunderbird to send the patch as a plain/text,
  format=fixed email. Default is <tt>false</tt>.
 </p>
 </dd>
 </dl></div>
 <h3 id="_examples">Examples</h3><div style="clear:left"></div>
 <div class="para"><p>Using tunnel mode:</p></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>[imap]
  folder = "INBOX.Drafts"
  tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</tt></pre>
 </div></div>
 <div class="para"><p>Using direct mode:</p></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>[imap]
  folder = "INBOX.Drafts"
  host = imap://imap.example.com
  user = bob
  pass = p4ssw0rd</tt></pre>
 </div></div>
 <div class="para"><p>Using direct mode with SSL:</p></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>[imap]
  folder = "INBOX.Drafts"
  host = imaps://imap.example.com
  user = bob
  pass = p4ssw0rd
  port = 123
  sslverify = false</tt></pre>
 </div></div>
 </div>
 <h2 id="_caution">CAUTION</h2>
 <div class="sectionbody">
 <div class="para"><p>It is still your responsibility to make sure that the email message
 sent by your email program meets the standards of your project.
 Many projects do not like patches to be attached. Some mail
 agents will transform patches (e.g. wrap lines, send them as
 format=flowed) in ways that make them fail. You will get angry
 flames ridiculing you if you don't check this.</p></div>
 <div class="para"><p>Thunderbird in particular is known to be problematic. Thunderbird
 users may wish to visit this web page for more information:
  http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email</p></div>
 </div>
 <h2 id="_bugs">BUGS</h2>
 <div class="sectionbody">
 <div class="para"><p>Doesn't handle lines starting with "From " in the message body.</p></div>
 </div>
 <h2 id="_author">Author</h2>
 <div class="sectionbody">
 <div class="para"><p>Derived from isync 1.0.1 by Mike McCormack.</p></div>
 </div>
 <h2 id="_documentation">Documentation</h2>
 <div class="sectionbody">
 <div class="para"><p>Documentation by Mike McCormack</p></div>
 </div>
 <h2 id="_git">GIT</h2>
 <div class="sectionbody">
 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 </div>
 <div id="footer">
 <div id="footer-text">
 Last updated 2009-07-01 02:30:53 UTC
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<meta name="generator" content="AsciiDoc 8.2.5" />
	<style type="text/css">
	/* Debug borders */
	p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
	/*
	border: 1px solid red;
	*/
	}

	body {
	margin: 1em 5% 1em 5%;
	}

	a {
	color: blue;
	text-decoration: underline;
	}
	a:visited {
	color: fuchsia;
	}

	em {
	font-style: italic;
	}

	strong {
	font-weight: bold;
	}

	tt {
	color: navy;
	}

	h1, h2, h3, h4, h5, h6 {
	color: #527bbd;
	font-family: sans-serif;
	margin-top: 1.2em;
	margin-bottom: 0.5em;
	line-height: 1.3;
	}

	h1, h2, h3 {
	border-bottom: 2px solid silver;
	}
	h2 {
	padding-top: 0.5em;
	}
	h3 {
	float: left;
	}
	h3 + * {
	clear: left;
	}

	div.sectionbody {
	font-family: serif;
	margin-left: 0;
	}

	hr {
	border: 1px solid silver;
	}

	p {
	margin-top: 0.5em;
	margin-bottom: 0.5em;
	}

	pre {
	padding: 0;
	margin: 0;
	}

	span#author {
	color: #527bbd;
	font-family: sans-serif;
	font-weight: bold;
	font-size: 1.1em;
	}
	span#email {
	}
	span#revision {
	font-family: sans-serif;
	}

	div#footer {
	font-family: sans-serif;
	font-size: small;
	border-top: 2px solid silver;
	padding-top: 0.5em;
	margin-top: 4.0em;
	}
	div#footer-text {
	float: left;
	padding-bottom: 0.5em;
	}
	div#footer-badges {
	float: right;
	padding-bottom: 0.5em;
	}

	div#preamble,
	div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
	div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
	div.admonitionblock {
	margin-right: 10%;
	margin-top: 1.5em;
	margin-bottom: 1.5em;
	}
	div.admonitionblock {
	margin-top: 2.5em;
	margin-bottom: 2.5em;
	}

	div.content { /* Block element content. */
	padding: 0;
	}

	/* Block element titles. */
	div.title, caption.title {
	font-family: sans-serif;
	font-weight: bold;
	text-align: left;
	margin-top: 1.0em;
	margin-bottom: 0.5em;
	}
	div.title + * {
	margin-top: 0;
	}

	td div.title:first-child {
	margin-top: 0.0em;
	}
	div.content div.title:first-child {
	margin-top: 0.0em;
	}
	div.content + div.title {
	margin-top: 0.0em;
	}

	div.sidebarblock > div.content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}

	div.listingblock {
	margin-right: 0%;
	}
	div.listingblock > div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock > div.content {
	padding-left: 2.0em;
	}

	div.attribution {
	text-align: right;
	}
	div.verseblock + div.attribution {
	text-align: left;
	}

	div.admonitionblock .icon {
	vertical-align: top;
	font-size: 1.1em;
	font-weight: bold;
	text-decoration: underline;
	color: #527bbd;
	padding-right: 0.5em;
	}
	div.admonitionblock td.content {
	padding-left: 0.5em;
	border-left: 2px solid silver;
	}

	div.exampleblock > div.content {
	border-left: 2px solid silver;
	padding: 0.5em;
	}

	div.verseblock div.content {
	white-space: pre;
	}

	div.imageblock div.content { padding-left: 0; }
	div.imageblock img { border: 1px solid silver; }
	span.image img { border-style: none; }

	dl {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	dt {
	margin-top: 0.5em;
	margin-bottom: 0;
	font-style: italic;
	}
	dd > *:first-child {
	margin-top: 0;
	}

	ul, ol {
	list-style-position: outside;
	}
	div.olist2 ol {
	list-style-type: lower-alpha;
	}

	div.tableblock > table {
	border: 3px solid #527bbd;
	}
	thead {
	font-family: sans-serif;
	font-weight: bold;
	}
	tfoot {
	font-weight: bold;
	}

	div.hlist {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	div.hlist td {
	padding-bottom: 5px;
	}
	td.hlist1 {
	vertical-align: top;
	font-style: italic;
	padding-right: 0.8em;
	}
	td.hlist2 {
	vertical-align: top;
	}

	@media print {
	div#footer-badges { display: none; }
	}

	div#toctitle {
	color: #527bbd;
	font-family: sans-serif;
	font-size: 1.1em;
	font-weight: bold;
	margin-top: 1.0em;
	margin-bottom: 0.1em;
	}

	div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
	margin-top: 0;
	margin-bottom: 0;
	}
	div.toclevel2 {
	margin-left: 2em;
	font-size: 0.9em;
	}
	div.toclevel3 {
	margin-left: 4em;
	font-size: 0.9em;
	}
	div.toclevel4 {
	margin-left: 6em;
	font-size: 0.9em;
	}
	include1::./stylesheets/xhtml11-manpage.css[]
	/* Workarounds for IE6's broken and incomplete CSS2. */

	div.sidebar-content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}
	div.sidebar-title, div.image-title {
	font-family: sans-serif;
	font-weight: bold;
	margin-top: 0.0em;
	margin-bottom: 0.5em;
	}

	div.listingblock div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock-content {
	padding-left: 2.0em;
	}

	div.exampleblock-content {
	border-left: 2px solid silver;
	padding-left: 0.5em;
	}

	/* IE6 sets dynamically generated links as visited. */
	div#toc a:visited { color: blue; }
	</style>
	<title>git-imap-send(1)</title>
	</head>
	<body>
	<div id="header">
	<h1>
	git-imap-send(1) Manual Page
	</h1>
	<h2>NAME</h2>
	<div class="sectionbody">
	<p>git-imap-send -
	Send a collection of patches from stdin to an IMAP folder
	</p>
	</div>
	</div>
	<h2>SYNOPSIS</h2>
	<div class="sectionbody">
	<div class="para"><p><em>git imap-send</em></p></div>
	</div>
	<h2 id="_description">DESCRIPTION</h2>
	<div class="sectionbody">
	<div class="para"><p>This command uploads a mailbox generated with <em>git-format-patch</em>
	into an IMAP drafts folder. This allows patches to be sent as
	other email is when using mail clients that cannot read mailbox
	files directly.</p></div>
	<div class="para"><p>Typical usage is something like:</p></div>
	<div class="para"><p>git format-patch --signoff --stdout --attach origin \| git imap-send</p></div>
	</div>
	<h2 id="_configuration">CONFIGURATION</h2>
	<div class="sectionbody">
	<div class="para"><p>To use the tool, imap.folder and either imap.tunnel or imap.host must be set
	to appropriate values.</p></div>
	<h3 id="_variables">Variables</h3><div style="clear:left"></div>
	<div class="vlist"><dl>
	<dt>
	imap.folder
	</dt>
	<dd>
	<p>
	The folder to drop the mails into, which is typically the Drafts
	folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
	"[Gmail]/Drafts". Required to use imap-send.
	</p>
	</dd>
	<dt>
	imap.tunnel
	</dt>
	<dd>
	<p>
	Command used to setup a tunnel to the IMAP server through which
	commands will be piped instead of using a direct network connection
	to the server. Required when imap.host is not set to use imap-send.
	</p>
	</dd>
	<dt>
	imap.host
	</dt>
	<dd>
	<p>
	A URL identifying the server. Use a <tt>imap://</tt> prefix for non-secure
	connections and a <tt>imaps://</tt> prefix for secure connections.
	Ignored when imap.tunnel is set, but required to use imap-send
	otherwise.
	</p>
	</dd>
	<dt>
	imap.user
	</dt>
	<dd>
	<p>
	The username to use when logging in to the server.
	</p>
	</dd>
	<dt>
	imap.pass
	</dt>
	<dd>
	<p>
	The password to use when logging in to the server.
	</p>
	</dd>
	<dt>
	imap.port
	</dt>
	<dd>
	<p>
	An integer port number to connect to on the server.
	Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
	Ignored when imap.tunnel is set.
	</p>
	</dd>
	<dt>
	imap.sslverify
	</dt>
	<dd>
	<p>
	A boolean to enable/disable verification of the server certificate
	used by the SSL/TLS connection. Default is <tt>true</tt>. Ignored when
	imap.tunnel is set.
	</p>
	</dd>
	<dt>
	imap.preformattedHTML
	</dt>
	<dd>
	<p>
	A boolean to enable/disable the use of html encoding when sending
	a patch. An html encoded patch will be bracketed with <pre>
	and have a content type of text/html. Ironically, enabling this
	option causes Thunderbird to send the patch as a plain/text,
	format=fixed email. Default is <tt>false</tt>.
	</p>
	</dd>
	</dl></div>
	<h3 id="_examples">Examples</h3><div style="clear:left"></div>
	<div class="para"><p>Using tunnel mode:</p></div>
	<div class="literalblock">
	<div class="content">
	<pre><tt>[imap]
	folder = "INBOX.Drafts"
	tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"</tt></pre>
	</div></div>
	<div class="para"><p>Using direct mode:</p></div>
	<div class="literalblock">
	<div class="content">
	<pre><tt>[imap]
	folder = "INBOX.Drafts"
	host = imap://imap.example.com
	user = bob
	pass = p4ssw0rd</tt></pre>
	</div></div>
	<div class="para"><p>Using direct mode with SSL:</p></div>
	<div class="literalblock">
	<div class="content">
	<pre><tt>[imap]
	folder = "INBOX.Drafts"
	host = imaps://imap.example.com
	user = bob
	pass = p4ssw0rd
	port = 123
	sslverify = false</tt></pre>
	</div></div>
	</div>
	<h2 id="_caution">CAUTION</h2>
	<div class="sectionbody">
	<div class="para"><p>It is still your responsibility to make sure that the email message
	sent by your email program meets the standards of your project.
	Many projects do not like patches to be attached. Some mail
	agents will transform patches (e.g. wrap lines, send them as
	format=flowed) in ways that make them fail. You will get angry
	flames ridiculing you if you don't check this.</p></div>
	<div class="para"><p>Thunderbird in particular is known to be problematic. Thunderbird
	users may wish to visit this web page for more information:
	http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email</p></div>
	</div>
	<h2 id="_bugs">BUGS</h2>
	<div class="sectionbody">
	<div class="para"><p>Doesn't handle lines starting with "From " in the message body.</p></div>
	</div>
	<h2 id="_author">Author</h2>
	<div class="sectionbody">
	<div class="para"><p>Derived from isync 1.0.1 by Mike McCormack.</p></div>
	</div>
	<h2 id="_documentation">Documentation</h2>
	<div class="sectionbody">
	<div class="para"><p>Documentation by Mike McCormack</p></div>
	</div>
	<h2 id="_git">GIT</h2>
	<div class="sectionbody">
	<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
	</div>
	<div id="footer">
	<div id="footer-text">
	Last updated 2009-07-01 02:30:53 UTC
	</div>
	</div>
	</body>
	</html>