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 Examples
  68 ~~~~~~~~
  69
  70 Using 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
  78 Using direct mode:
  79
  80 .........................
  81 [imap]
  82     folder = "INBOX.Drafts"
  83     host = imap://imap.example.com
  84     user = bob
  85     pass = p4ssw0rd
  86 ..........................
  87
  88 Using 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
 101 CAUTION
 102 -------
 103 It is still your responsibility to make sure that the email message
 104 sent by your email program meets the standards of your project.
 105 Many projects do not like patches to be attached.  Some mail
 106 agents will transform patches (e.g. wrap lines, send them as
 107 format=flowed) in ways that make them fail.  You will get angry
 108 flames ridiculing you if you don't check this.
 109
 110 Thunderbird in particular is known to be problematic.  Thunderbird
 111 users 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
 115 BUGS
 116 ----
 117 Doesn't handle lines starting with "From " in the message body.
 118
 119
 120 Author
 121 ------
 122 Derived from isync 1.0.1 by Mike McCormack.
 123
 124 Documentation
 125 --------------
 126 Documentation by Mike McCormack
 127
 128 GIT
 129 ---
 130 Part of the linkgit:git[1] suite