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.4.5" />
   7 <title>git-imap-send(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-imap-send(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-imap-send -
 411    Send a collection of patches from stdin to an IMAP folder
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content"><em>git imap-send</em></div>
 419 <div class="verseblock-attribution">
 420 </div></div>
 421 </div>
 422 <h2 id="_description">DESCRIPTION</h2>
 423 <div class="sectionbody">
 424 <div class="paragraph"><p>This command uploads a mailbox generated with <em>git format-patch</em>
 425 into an IMAP drafts folder.  This allows patches to be sent as
 426 other email is when using mail clients that cannot read mailbox
 427 files directly. The command also works with any general mailbox
 428 in which emails have the fields "From", "Date", and "Subject" in
 429 that order.</p></div>
 430 <div class="paragraph"><p>Typical usage is something like:</p></div>
 431 <div class="paragraph"><p>git format-patch --signoff --stdout --attach origin | git imap-send</p></div>
 432 </div>
 433 <h2 id="_configuration">CONFIGURATION</h2>
 434 <div class="sectionbody">
 435 <div class="paragraph"><p>To use the tool, imap.folder and either imap.tunnel or imap.host must be set
 436 to appropriate values.</p></div>
 437 <h3 id="_variables">Variables</h3><div style="clear:left"></div>
 438 <div class="dlist"><dl>
 439 <dt class="hdlist1">
 440 imap.folder
 441 </dt>
 442 <dd>
 443 <p>
 444         The folder to drop the mails into, which is typically the Drafts
 445         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
 446         "[Gmail]/Drafts". Required to use imap-send.
 447 </p>
 448 </dd>
 449 <dt class="hdlist1">
 450 imap.tunnel
 451 </dt>
 452 <dd>
 453 <p>
 454         Command used to setup a tunnel to the IMAP server through which
 455         commands will be piped instead of using a direct network connection
 456         to the server. Required when imap.host is not set to use imap-send.
 457 </p>
 458 </dd>
 459 <dt class="hdlist1">
 460 imap.host
 461 </dt>
 462 <dd>
 463 <p>
 464         A URL identifying the server. Use a <tt>imap://</tt> prefix for non-secure
 465         connections and a <tt>imaps://</tt> prefix for secure connections.
 466         Ignored when imap.tunnel is set, but required to use imap-send
 467         otherwise.
 468 </p>
 469 </dd>
 470 <dt class="hdlist1">
 471 imap.user
 472 </dt>
 473 <dd>
 474 <p>
 475         The username to use when logging in to the server.
 476 </p>
 477 </dd>
 478 <dt class="hdlist1">
 479 imap.pass
 480 </dt>
 481 <dd>
 482 <p>
 483         The password to use when logging in to the server.
 484 </p>
 485 </dd>
 486 <dt class="hdlist1">
 487 imap.port
 488 </dt>
 489 <dd>
 490 <p>
 491         An integer port number to connect to on the server.
 492         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
 493         Ignored when imap.tunnel is set.
 494 </p>
 495 </dd>
 496 <dt class="hdlist1">
 497 imap.sslverify
 498 </dt>
 499 <dd>
 500 <p>
 501         A boolean to enable/disable verification of the server certificate
 502         used by the SSL/TLS connection. Default is <tt>true</tt>. Ignored when
 503         imap.tunnel is set.
 504 </p>
 505 </dd>
 506 <dt class="hdlist1">
 507 imap.preformattedHTML
 508 </dt>
 509 <dd>
 510 <p>
 511         A boolean to enable/disable the use of html encoding when sending
 512         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;
 513         and have a content type of text/html.  Ironically, enabling this
 514         option causes Thunderbird to send the patch as a plain/text,
 515         format=fixed email.  Default is <tt>false</tt>.
 516 </p>
 517 </dd>
 518 <dt class="hdlist1">
 519 imap.authMethod
 520 </dt>
 521 <dd>
 522 <p>
 523         Specify authenticate method for authentication with IMAP server.
 524         Current supported method is <em>CRAM-MD5</em> only.
 525 </p>
 526 </dd>
 527 </dl></div>
 528 <h3 id="_examples">Examples</h3><div style="clear:left"></div>
 529 <div class="paragraph"><p>Using tunnel mode:</p></div>
 530 <div class="literalblock">
 531 <div class="content">
 532 <pre><tt>[imap]
 533     folder = "INBOX.Drafts"
 534     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</tt></pre>
 535 </div></div>
 536 <div class="paragraph"><p>Using direct mode:</p></div>
 537 <div class="literalblock">
 538 <div class="content">
 539 <pre><tt>[imap]
 540     folder = "INBOX.Drafts"
 541     host = imap://imap.example.com
 542     user = bob
 543     pass = p4ssw0rd</tt></pre>
 544 </div></div>
 545 <div class="paragraph"><p>Using direct mode with SSL:</p></div>
 546 <div class="literalblock">
 547 <div class="content">
 548 <pre><tt>[imap]
 549     folder = "INBOX.Drafts"
 550     host = imaps://imap.example.com
 551     user = bob
 552     pass = p4ssw0rd
 553     port = 123
 554     sslverify = false</tt></pre>
 555 </div></div>
 556 </div>
 557 <h2 id="_example">EXAMPLE</h2>
 558 <div class="sectionbody">
 559 <div class="paragraph"><p>To submit patches using GMail&#8217;s IMAP interface, first, edit your ~/.gitconfig
 560 to specify your account settings:</p></div>
 561 <div class="listingblock">
 562 <div class="content">
 563 <pre><tt>[imap]
 564         folder = "[Gmail]/Drafts"
 565         host = imaps://imap.gmail.com
 566         user = user@gmail.com
 567         port = 993
 568         sslverify = false</tt></pre>
 569 </div></div>
 570 <div class="paragraph"><p>You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
 571 that the "Folder doesn&#8217;t exist".</p></div>
 572 <div class="paragraph"><p>Once the commits are ready to be sent, run the following command:</p></div>
 573 <div class="literalblock">
 574 <div class="content">
 575 <pre><tt>$ git format-patch --cover-letter -M --stdout origin/master | git imap-send</tt></pre>
 576 </div></div>
 577 <div class="paragraph"><p>Just make sure to disable line wrapping in the email client (GMail&#8217;s web
 578 interface will wrap lines no matter what, so you need to use a real
 579 IMAP client).</p></div>
 580 </div>
 581 <h2 id="_caution">CAUTION</h2>
 582 <div class="sectionbody">
 583 <div class="paragraph"><p>It is still your responsibility to make sure that the email message
 584 sent by your email program meets the standards of your project.
 585 Many projects do not like patches to be attached.  Some mail
 586 agents will transform patches (e.g. wrap lines, send them as
 587 format=flowed) in ways that make them fail.  You will get angry
 588 flames ridiculing you if you don&#8217;t check this.</p></div>
 589 <div class="paragraph"><p>Thunderbird in particular is known to be problematic.  Thunderbird
 590 users may wish to visit this web page for more information:
 591   <a href="http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email">http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email</a></p></div>
 592 </div>
 593 <h2 id="_see_also">SEE ALSO</h2>
 594 <div class="sectionbody">
 595 <div class="paragraph"><p><a href="git-format-patch.html">git-format-patch(1)</a>, <a href="git-send-email.html">git-send-email(1)</a>, mbox(5)</p></div>
 596 </div>
 597 <h2 id="_git">GIT</h2>
 598 <div class="sectionbody">
 599 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 600 </div>
 601 <div id="footer">
 602 <div id="footer-text">
 603 Last updated 2011-07-23 00:49:30 UTC
 604 </div>
 605 </div>
 606 </body>
 607 </html>