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