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 [verse]
  12 'git imap-send' [-v] [-q] [--[no-]curl]
  13
  14
  15 DESCRIPTION
  16 -----------
  17 This command uploads a mailbox generated with 'git format-patch'
  18 into an IMAP drafts folder.  This allows patches to be sent as
  19 other email is when using mail clients that cannot read mailbox
  20 files directly. The command also works with any general mailbox
  21 in which emails have the fields "From", "Date", and "Subject" in
  22 that order.
  23
  24 Typical usage is something like:
  25
  26 git format-patch --signoff --stdout --attach origin | git imap-send
  27
  28
  29 OPTIONS
  30 -------
  31
  32 -v::
  33 --verbose::
  34         Be verbose.
  35
  36 -q::
  37 --quiet::
  38         Be quiet.
  39
  40 --curl::
  41         Use libcurl to communicate with the IMAP server, unless tunneling
  42         into it.  Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
  43         option set.
  44
  45 --no-curl::
  46         Talk to the IMAP server using git's own IMAP routines instead of
  47         using libcurl.
  48
  49
  50 CONFIGURATION
  51 -------------
  52
  53 To use the tool, imap.folder and either imap.tunnel or imap.host must be set
  54 to appropriate values.
  55
  56 Variables
  57 ~~~~~~~~~
  58
  59 imap.folder::
  60         The folder to drop the mails into, which is typically the Drafts
  61         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
  62         "[Gmail]/Drafts". Required.
  63
  64 imap.tunnel::
  65         Command used to setup a tunnel to the IMAP server through which
  66         commands will be piped instead of using a direct network connection
  67         to the server. Required when imap.host is not set.
  68
  69 imap.host::
  70         A URL identifying the server. Use a `imap://` prefix for non-secure
  71         connections and a `imaps://` prefix for secure connections.
  72         Ignored when imap.tunnel is set, but required otherwise.
  73
  74 imap.user::
  75         The username to use when logging in to the server.
  76
  77 imap.pass::
  78         The password to use when logging in to the server.
  79
  80 imap.port::
  81         An integer port number to connect to on the server.
  82         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
  83         Ignored when imap.tunnel is set.
  84
  85 imap.sslverify::
  86         A boolean to enable/disable verification of the server certificate
  87         used by the SSL/TLS connection. Default is `true`. Ignored when
  88         imap.tunnel is set.
  89
  90 imap.preformattedHTML::
  91         A boolean to enable/disable the use of html encoding when sending
  92         a patch.  An html encoded patch will be bracketed with <pre>
  93         and have a content type of text/html.  Ironically, enabling this
  94         option causes Thunderbird to send the patch as a plain/text,
  95         format=fixed email.  Default is `false`.
  96
  97 imap.authMethod::
  98         Specify authenticate method for authentication with IMAP server.
  99         If Git was built with the NO_CURL option, or if your curl version is older
 100         than 7.34.0, or if you're running git-imap-send with the `--no-curl`
 101         option, the only supported method is 'CRAM-MD5'. If this is not set
 102         then 'git imap-send' uses the basic IMAP plaintext LOGIN command.
 103
 104 Examples
 105 ~~~~~~~~
 106
 107 Using tunnel mode:
 108
 109 ..........................
 110 [imap]
 111     folder = "INBOX.Drafts"
 112     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
 113 ..........................
 114
 115 Using direct mode:
 116
 117 .........................
 118 [imap]
 119     folder = "INBOX.Drafts"
 120     host = imap://imap.example.com
 121     user = bob
 122     pass = p4ssw0rd
 123 .........................
 124
 125 Using direct mode with SSL:
 126
 127 .........................
 128 [imap]
 129     folder = "INBOX.Drafts"
 130     host = imaps://imap.example.com
 131     user = bob
 132     pass = p4ssw0rd
 133     port = 123
 134     sslverify = false
 135 .........................
 136
 137
 138 EXAMPLE
 139 -------
 140 To submit patches using GMail's IMAP interface, first, edit your ~/.gitconfig
 141 to specify your account settings:
 142
 143 ---------
 144 [imap]
 145         folder = "[Gmail]/Drafts"
 146         host = imaps://imap.gmail.com
 147         user = user@gmail.com
 148         port = 993
 149         sslverify = false
 150 ---------
 151
 152 You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
 153 that the "Folder doesn't exist".
 154
 155 Once the commits are ready to be sent, run the following command:
 156
 157   $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
 158
 159 Just make sure to disable line wrapping in the email client (GMail's web
 160 interface will wrap lines no matter what, so you need to use a real
 161 IMAP client).
 162
 163 CAUTION
 164 -------
 165 It is still your responsibility to make sure that the email message
 166 sent by your email program meets the standards of your project.
 167 Many projects do not like patches to be attached.  Some mail
 168 agents will transform patches (e.g. wrap lines, send them as
 169 format=flowed) in ways that make them fail.  You will get angry
 170 flames ridiculing you if you don't check this.
 171
 172 Thunderbird in particular is known to be problematic.  Thunderbird
 173 users may wish to visit this web page for more information:
 174   http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
 175
 176 SEE ALSO
 177 --------
 178 linkgit:git-format-patch[1], linkgit:git-send-email[1], mbox(5)
 179
 180 GIT
 181 ---
 182 Part of the linkgit:git[1] suite