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 imap.authMethod::
  75         Specify authenticate method for authentication with IMAP server.
  76         Current supported method is 'CRAM-MD5' only.
  77
  78 Examples
  79 ~~~~~~~~
  80
  81 Using tunnel mode:
  82
  83 ..........................
  84 [imap]
  85     folder = "INBOX.Drafts"
  86     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
  87 ..........................
  88
  89 Using direct mode:
  90
  91 .........................
  92 [imap]
  93     folder = "INBOX.Drafts"
  94     host = imap://imap.example.com
  95     user = bob
  96     pass = p4ssw0rd
  97 ..........................
  98
  99 Using direct mode with SSL:
 100
 101 .........................
 102 [imap]
 103     folder = "INBOX.Drafts"
 104     host = imaps://imap.example.com
 105     user = bob
 106     pass = p4ssw0rd
 107     port = 123
 108     sslverify = false
 109 ..........................
 110
 111
 112 CAUTION
 113 -------
 114 It is still your responsibility to make sure that the email message
 115 sent by your email program meets the standards of your project.
 116 Many projects do not like patches to be attached.  Some mail
 117 agents will transform patches (e.g. wrap lines, send them as
 118 format=flowed) in ways that make them fail.  You will get angry
 119 flames ridiculing you if you don't check this.
 120
 121 Thunderbird in particular is known to be problematic.  Thunderbird
 122 users may wish to visit this web page for more information:
 123   http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
 124
 125
 126 BUGS
 127 ----
 128 Doesn't handle lines starting with "From " in the message body.
 129
 130
 131 Author
 132 ------
 133 Derived from isync 1.0.1 by Mike McCormack.
 134
 135 Documentation
 136 --------------
 137 Documentation by Mike McCormack
 138
 139 GIT
 140 ---
 141 Part of the linkgit:git[1] suite