Documentation/git-imap-send.txt

   1 git-imap-send(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-imap-send - Send a collection of patches from stdin to an IMAP folder
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git imap-send'
  12
  13
  14 DESCRIPTION
  15 -----------
  16 This command uploads a mailbox generated with 'git format-patch'
  17 into an IMAP drafts folder.  This allows patches to be sent as
  18 other email is when using mail clients that cannot read mailbox
  19 files directly.
  20
  21 Typical usage is something like:
  22
  23 git format-patch --signoff --stdout --attach origin | git imap-send
  24
  25
  26 CONFIGURATION
  27 -------------
  28
  29 To use the tool, imap.folder and either imap.tunnel or imap.host must be set
  30 to appropriate values.
  31
  32 Variables
  33 ~~~~~~~~~
  34
  35 imap.folder::
  36         The folder to drop the mails into, which is typically the Drafts
  37         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
  38         "[Gmail]/Drafts". Required to use imap-send.
  39
  40 imap.tunnel::
  41         Command used to setup a tunnel to the IMAP server through which
  42         commands will be piped instead of using a direct network connection
  43         to the server. Required when imap.host is not set to use imap-send.
  44
  45 imap.host::
  46         A URL identifying the server. Use a `imap://` prefix for non-secure
  47         connections and a `imaps://` prefix for secure connections.
  48         Ignored when imap.tunnel is set, but required to use imap-send
  49         otherwise.
  50
  51 imap.user::
  52         The username to use when logging in to the server.
  53
  54 imap.pass::
  55         The password to use when logging in to the server.
  56
  57 imap.port::
  58         An integer port number to connect to on the server.
  59         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
  60         Ignored when imap.tunnel is set.
  61
  62 imap.sslverify::
  63         A boolean to enable/disable verification of the server certificate
  64         used by the SSL/TLS connection. Default is `true`. Ignored when
  65         imap.tunnel is set.
  66
  67 imap.preformattedHTML::
  68         A boolean to enable/disable the use of html encoding when sending
  69         a patch.  An html encoded patch will be bracketed with <pre>
  70         and have a content type of text/html.  Ironically, enabling this
  71         option causes Thunderbird to send the patch as a plain/text,
  72         format=fixed email.  Default is `false`.
  73
  74 Examples
  75 ~~~~~~~~
  76
  77 Using tunnel mode:
  78
  79 ..........................
  80 [imap]
  81     folder = "INBOX.Drafts"
  82     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
  83 ..........................
  84
  85 Using direct mode:
  86
  87 .........................
  88 [imap]
  89     folder = "INBOX.Drafts"
  90     host = imap://imap.example.com
  91     user = bob
  92     pass = p4ssw0rd
  93 ..........................
  94
  95 Using direct mode with SSL:
  96
  97 .........................
  98 [imap]
  99     folder = "INBOX.Drafts"
 100     host = imaps://imap.example.com
 101     user = bob
 102     pass = p4ssw0rd
 103     port = 123
 104     sslverify = false
 105 ..........................
 106
 107
 108 CAUTION
 109 -------
 110 It is still your responsibility to make sure that the email message
 111 sent by your email program meets the standards of your project.
 112 Many projects do not like patches to be attached.  Some mail
 113 agents will transform patches (e.g. wrap lines, send them as
 114 format=flowed) in ways that make them fail.  You will get angry
 115 flames ridiculing you if you don't check this.
 116
 117 Thunderbird in particular is known to be problematic.  Thunderbird
 118 users may wish to visit this web page for more information:
 119   http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
 120
 121
 122 BUGS
 123 ----
 124 Doesn't handle lines starting with "From " in the message body.
 125
 126
 127 Author
 128 ------
 129 Derived from isync 1.0.1 by Mike McCormack.
 130
 131 Documentation
 132 --------------
 133 Documentation by Mike McCormack
 134
 135 GIT
 136 ---
 137 Part of the linkgit:git[1] suite