git-imap-send.html

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