Documentation / git-imap-send.txton commit builtin-remote: remove unused code in get_ref_states (7b9a5e2)
   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.
  20
  21Typical usage is something like:
  22
  23git format-patch --signoff --stdout --attach origin | git imap-send
  24
  25
  26CONFIGURATION
  27-------------
  28
  29To use the tool, imap.folder and either imap.tunnel or imap.host must be set
  30to appropriate values.
  31
  32Variables
  33~~~~~~~~~
  34
  35imap.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
  40imap.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
  45imap.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
  51imap.user::
  52        The username to use when logging in to the server.
  53
  54imap.password::
  55        The password to use when logging in to the server.
  56
  57imap.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
  62imap.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
  67Examples
  68~~~~~~~~
  69
  70Using tunnel mode:
  71
  72..........................
  73[imap]
  74    folder = "INBOX.Drafts"
  75    tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
  76..........................
  77
  78Using direct mode:
  79
  80.........................
  81[imap]
  82    folder = "INBOX.Drafts"
  83    host = imap://imap.example.com
  84    user = bob
  85    pass = p4ssw0rd
  86..........................
  87
  88Using direct mode with SSL:
  89
  90.........................
  91[imap]
  92    folder = "INBOX.Drafts"
  93    host = imaps://imap.example.com
  94    user = bob
  95    pass = p4ssw0rd
  96    port = 123
  97    sslverify = false
  98..........................
  99
 100
 101CAUTION
 102-------
 103It is still your responsibility to make sure that the email message
 104sent by your email program meets the standards of your project.
 105Many projects do not like patches to be attached.  Some mail
 106agents will transform patches (e.g. wrap lines, send them as
 107format=flowed) in ways that make them fail.  You will get angry
 108flames ridiculing you if you don't check this.
 109
 110Thunderbird in particular is known to be problematic.  Thunderbird
 111users may wish to visit this web page for more information:
 112  http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
 113
 114
 115BUGS
 116----
 117Doesn't handle lines starting with "From " in the message body.
 118
 119
 120Author
 121------
 122Derived from isync 1.0.1 by Mike McCormack.
 123
 124Documentation
 125--------------
 126Documentation by Mike McCormack
 127
 128GIT
 129---
 130Part of the linkgit:git[1] suite