man1/git-imap-send.1

   1 '\" t
   2 .\"     Title: git-imap-send
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 12/10/2021
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.34.1.182.ge773545c7f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-IMAP\-SEND" "1" "12/10/2021" "Git 2\&.34\&.1\&.182\&.ge77354" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-imap-send \- Send a collection of patches from stdin to an IMAP folder
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit imap\-send\fR [\-v] [\-q] [\-\-[no\-]curl]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 This command uploads a mailbox generated with \fIgit format\-patch\fR into an IMAP drafts folder\&. This allows patches to be sent as other email is when using mail clients that cannot read mailbox files directly\&. The command also works with any general mailbox in which emails have the fields "From", "Date", and "Subject" in that order\&.
  41 .sp
  42 Typical usage is something like:
  43 .sp
  44 git format\-patch \-\-signoff \-\-stdout \-\-attach origin | git imap\-send
  45 .SH "OPTIONS"
  46 .PP
  47 \-v, \-\-verbose
  48 .RS 4
  49 Be verbose\&.
  50 .RE
  51 .PP
  52 \-q, \-\-quiet
  53 .RS 4
  54 Be quiet\&.
  55 .RE
  56 .PP
  57 \-\-curl
  58 .RS 4
  59 Use libcurl to communicate with the IMAP server, unless tunneling into it\&. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND option set\&.
  60 .RE
  61 .PP
  62 \-\-no\-curl
  63 .RS 4
  64 Talk to the IMAP server using git\(cqs own IMAP routines instead of using libcurl\&. Ignored if Git was built with the NO_OPENSSL option set\&.
  65 .RE
  66 .SH "CONFIGURATION"
  67 .sp
  68 To use the tool, \fBimap\&.folder\fR and either \fBimap\&.tunnel\fR or \fBimap\&.host\fR must be set to appropriate values\&.
  69 .PP
  70 imap\&.folder
  71 .RS 4
  72 The folder to drop the mails into, which is typically the Drafts folder\&. For example: "INBOX\&.Drafts", "INBOX/Drafts" or "[Gmail]/Drafts"\&. Required\&.
  73 .RE
  74 .PP
  75 imap\&.tunnel
  76 .RS 4
  77 Command used to setup a tunnel to the IMAP server through which commands will be piped instead of using a direct network connection to the server\&. Required when imap\&.host is not set\&.
  78 .RE
  79 .PP
  80 imap\&.host
  81 .RS 4
  82 A URL identifying the server\&. Use an
  83 \fBimap://\fR
  84 prefix for non\-secure connections and an
  85 \fBimaps://\fR
  86 prefix for secure connections\&. Ignored when imap\&.tunnel is set, but required otherwise\&.
  87 .RE
  88 .PP
  89 imap\&.user
  90 .RS 4
  91 The username to use when logging in to the server\&.
  92 .RE
  93 .PP
  94 imap\&.pass
  95 .RS 4
  96 The password to use when logging in to the server\&.
  97 .RE
  98 .PP
  99 imap\&.port
 100 .RS 4
 101 An integer port number to connect to on the server\&. Defaults to 143 for imap:// hosts and 993 for imaps:// hosts\&. Ignored when imap\&.tunnel is set\&.
 102 .RE
 103 .PP
 104 imap\&.sslverify
 105 .RS 4
 106 A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection\&. Default is
 107 \fBtrue\fR\&. Ignored when imap\&.tunnel is set\&.
 108 .RE
 109 .PP
 110 imap\&.preformattedHTML
 111 .RS 4
 112 A boolean to enable/disable the use of html encoding when sending a patch\&. An html encoded patch will be bracketed with <pre> and have a content type of text/html\&. Ironically, enabling this option causes Thunderbird to send the patch as a plain/text, format=fixed email\&. Default is
 113 \fBfalse\fR\&.
 114 .RE
 115 .PP
 116 imap\&.authMethod
 117 .RS 4
 118 Specify authenticate method for authentication with IMAP server\&. If Git was built with the NO_CURL option, or if your curl version is older than 7\&.34\&.0, or if you\(cqre running git\-imap\-send with the
 119 \fB\-\-no\-curl\fR
 120 option, the only supported method is
 121 \fICRAM\-MD5\fR\&. If this is not set then
 122 \fIgit imap\-send\fR
 123 uses the basic IMAP plaintext LOGIN command\&.
 124 .RE
 125 .SH "EXAMPLES"
 126 .sp
 127 Using tunnel mode:
 128 .sp
 129 .if n \{\
 130 .RS 4
 131 .\}
 132 .nf
 133 [imap]
 134     folder = "INBOX\&.Drafts"
 135     tunnel = "ssh \-q \-C user@example\&.com /usr/bin/imapd \&./Maildir 2> /dev/null"
 136 .fi
 137 .if n \{\
 138 .RE
 139 .\}
 140 .sp
 141 Using direct mode:
 142 .sp
 143 .if n \{\
 144 .RS 4
 145 .\}
 146 .nf
 147 [imap]
 148     folder = "INBOX\&.Drafts"
 149     host = imap://imap\&.example\&.com
 150     user = bob
 151     pass = p4ssw0rd
 152 .fi
 153 .if n \{\
 154 .RE
 155 .\}
 156 .sp
 157 Using direct mode with SSL:
 158 .sp
 159 .if n \{\
 160 .RS 4
 161 .\}
 162 .nf
 163 [imap]
 164     folder = "INBOX\&.Drafts"
 165     host = imaps://imap\&.example\&.com
 166     user = bob
 167     pass = p4ssw0rd
 168     port = 123
 169     ; sslVerify = false
 170 .fi
 171 .if n \{\
 172 .RE
 173 .\}
 174 .sp
 175 .if n \{\
 176 .sp
 177 .\}
 178 .RS 4
 179 .it 1 an-trap
 180 .nr an-no-space-flag 1
 181 .nr an-break-flag 1
 182 .br
 183 .ps +1
 184 \fBNote\fR
 185 .ps -1
 186 .br
 187 .sp
 188 You may want to use \fBsslVerify=false\fR while troubleshooting, if you suspect that the reason you are having trouble connecting is because the certificate you use at the private server \fBexample\&.com\fR you are trying to set up (or have set up) may not be verified correctly\&.
 189 .sp .5v
 190 .RE
 191 .sp
 192 Using Gmail\(cqs IMAP interface:
 193 .sp
 194 .if n \{\
 195 .RS 4
 196 .\}
 197 .nf
 198 [imap]
 199         folder = "[Gmail]/Drafts"
 200         host = imaps://imap\&.gmail\&.com
 201         user = user@gmail\&.com
 202         port = 993
 203 .fi
 204 .if n \{\
 205 .RE
 206 .\}
 207 .sp
 208 .if n \{\
 209 .sp
 210 .\}
 211 .RS 4
 212 .it 1 an-trap
 213 .nr an-no-space-flag 1
 214 .nr an-break-flag 1
 215 .br
 216 .ps +1
 217 \fBNote\fR
 218 .ps -1
 219 .br
 220 .sp
 221 You might need to instead use: \fBfolder = "[Google Mail]/Drafts"\fR if you get an error that the "Folder doesn\(cqt exist"\&.
 222 .sp .5v
 223 .RE
 224 .if n \{\
 225 .sp
 226 .\}
 227 .RS 4
 228 .it 1 an-trap
 229 .nr an-no-space-flag 1
 230 .nr an-break-flag 1
 231 .br
 232 .ps +1
 233 \fBNote\fR
 234 .ps -1
 235 .br
 236 .sp
 237 If your Gmail account is set to another language than English, the name of the "Drafts" folder will be localized\&.
 238 .sp .5v
 239 .RE
 240 .sp
 241 Once the commits are ready to be sent, run the following command:
 242 .sp
 243 .if n \{\
 244 .RS 4
 245 .\}
 246 .nf
 247 $ git format\-patch \-\-cover\-letter \-M \-\-stdout origin/master | git imap\-send
 248 .fi
 249 .if n \{\
 250 .RE
 251 .\}
 252 .sp
 253 Just make sure to disable line wrapping in the email client (Gmail\(cqs web interface will wrap lines no matter what, so you need to use a real IMAP client)\&.
 254 .SH "CAUTION"
 255 .sp
 256 It is still your responsibility to make sure that the email message sent by your email program meets the standards of your project\&. Many projects do not like patches to be attached\&. Some mail agents will transform patches (e\&.g\&. wrap lines, send them as format=flowed) in ways that make them fail\&. You will get angry flames ridiculing you if you don\(cqt check this\&.
 257 .sp
 258 Thunderbird in particular is known to be problematic\&. Thunderbird users may wish to visit this web page for more information: \m[blue]\fBhttp://kb\&.mozillazine\&.org/Plain_text_e\-mail_\-_Thunderbird#Completely_plain_email\fR\m[]
 259 .SH "SEE ALSO"
 260 .sp
 261 \fBgit-format-patch\fR(1), \fBgit-send-email\fR(1), mbox(5)
 262 .SH "GIT"
 263 .sp
 264 Part of the \fBgit\fR(1) suite