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