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' [-v] [-q] [--[no-]curl]
  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 OPTIONS
  30 -------
  31
  32 -v::
  33 --verbose::
  34         Be verbose.
  35
  36 -q::
  37 --quiet::
  38         Be quiet.
  39
  40 --curl::
  41         Use libcurl to communicate with the IMAP server, unless tunneling
  42         into it.  Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
  43         option set.
  44
  45 --no-curl::
  46         Talk to the IMAP server using git's own IMAP routines instead of
  47         using libcurl.  Ignored if Git was built with the NO_OPENSSL option
  48         set.
  49
  50
  51 CONFIGURATION
  52 -------------
  53
  54 To use the tool, `imap.folder` and either `imap.tunnel` or `imap.host` must be set
  55 to appropriate values.
  56
  57 include::config/imap.txt[]
  58
  59 EXAMPLES
  60 --------
  61 Using tunnel mode:
  62
  63 ..........................
  64 [imap]
  65     folder = "INBOX.Drafts"
  66     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
  67 ..........................
  68
  69 Using direct mode:
  70
  71 .........................
  72 [imap]
  73     folder = "INBOX.Drafts"
  74     host = imap://imap.example.com
  75     user = bob
  76     pass = p4ssw0rd
  77 .........................
  78
  79 Using direct mode with SSL:
  80
  81 .........................
  82 [imap]
  83     folder = "INBOX.Drafts"
  84     host = imaps://imap.example.com
  85     user = bob
  86     pass = p4ssw0rd
  87     port = 123
  88     ; sslVerify = false
  89 .........................
  90
  91
  92 [NOTE]
  93 You may want to use `sslVerify=false`
  94 while troubleshooting, if you suspect that the reason you are
  95 having trouble connecting is because the certificate you use at
  96 the private server `example.com` you are trying to set up (or
  97 have set up) may not be verified correctly.
  98
  99 Using Gmail's IMAP interface:
 100
 101 ---------
 102 [imap]
 103         folder = "[Gmail]/Drafts"
 104         host = imaps://imap.gmail.com
 105         user = user@gmail.com
 106         port = 993
 107 ---------
 108
 109 [NOTE]
 110 You might need to instead use: `folder = "[Google Mail]/Drafts"` if you get an error
 111 that the "Folder doesn't exist".
 112
 113 [NOTE]
 114 If your Gmail account is set to another language than English, the name of the "Drafts"
 115 folder will be localized.
 116
 117 Once the commits are ready to be sent, run the following command:
 118
 119   $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
 120
 121 Just make sure to disable line wrapping in the email client (Gmail's web
 122 interface will wrap lines no matter what, so you need to use a real
 123 IMAP client).
 124
 125 CAUTION
 126 -------
 127 It is still your responsibility to make sure that the email message
 128 sent by your email program meets the standards of your project.
 129 Many projects do not like patches to be attached.  Some mail
 130 agents will transform patches (e.g. wrap lines, send them as
 131 format=flowed) in ways that make them fail.  You will get angry
 132 flames ridiculing you if you don't check this.
 133
 134 Thunderbird in particular is known to be problematic.  Thunderbird
 135 users may wish to visit this web page for more information:
 136   http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
 137
 138 SEE ALSO
 139 --------
 140 linkgit:git-format-patch[1], linkgit:git-send-email[1], mbox(5)
 141
 142 GIT
 143 ---
 144 Part of the linkgit:git[1] suite