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: 2023-09-13
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.42.0.176.gd6c51973e4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-IMAP\-SEND" "1" "2023\-09\-13" "Git 2\&.42\&.0\&.176\&.gd6c519" "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 .sp
  70 Everything above this line in this section isn\(cqt included from the \fBgit-config\fR(1) documentation\&. The content that follows is the same as what\(cqs found there:
  71 .PP
  72 imap\&.folder
  73 .RS 4
  74 The folder to drop the mails into, which is typically the Drafts folder\&. For example: "INBOX\&.Drafts", "INBOX/Drafts" or "[Gmail]/Drafts"\&. Required\&.
  75 .RE
  76 .PP
  77 imap\&.tunnel
  78 .RS 4
  79 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\&.
  80 .RE
  81 .PP
  82 imap\&.host
  83 .RS 4
  84 A URL identifying the server\&. Use an
  85 \fBimap://\fR
  86 prefix for non\-secure connections and an
  87 \fBimaps://\fR
  88 prefix for secure connections\&. Ignored when imap\&.tunnel is set, but required otherwise\&.
  89 .RE
  90 .PP
  91 imap\&.user
  92 .RS 4
  93 The username to use when logging in to the server\&.
  94 .RE
  95 .PP
  96 imap\&.pass
  97 .RS 4
  98 The password to use when logging in to the server\&.
  99 .RE
 100 .PP
 101 imap\&.port
 102 .RS 4
 103 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\&.
 104 .RE
 105 .PP
 106 imap\&.sslverify
 107 .RS 4
 108 A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection\&. Default is
 109 \fBtrue\fR\&. Ignored when imap\&.tunnel is set\&.
 110 .RE
 111 .PP
 112 imap\&.preformattedHTML
 113 .RS 4
 114 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
 115 \fBfalse\fR\&.
 116 .RE
 117 .PP
 118 imap\&.authMethod
 119 .RS 4
 120 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
 121 \fB\-\-no\-curl\fR
 122 option, the only supported method is
 123 \fICRAM\-MD5\fR\&. If this is not set then
 124 \fIgit imap\-send\fR
 125 uses the basic IMAP plaintext LOGIN command\&.
 126 .RE
 127 .SH "EXAMPLES"
 128 .sp
 129 Using tunnel mode:
 130 .sp
 131 .if n \{\
 132 .RS 4
 133 .\}
 134 .nf
 135 [imap]
 136     folder = "INBOX\&.Drafts"
 137     tunnel = "ssh \-q \-C user@example\&.com /usr/bin/imapd \&./Maildir 2> /dev/null"
 138 .fi
 139 .if n \{\
 140 .RE
 141 .\}
 142 .sp
 143 Using direct mode:
 144 .sp
 145 .if n \{\
 146 .RS 4
 147 .\}
 148 .nf
 149 [imap]
 150     folder = "INBOX\&.Drafts"
 151     host = imap://imap\&.example\&.com
 152     user = bob
 153     pass = p4ssw0rd
 154 .fi
 155 .if n \{\
 156 .RE
 157 .\}
 158 .sp
 159 Using direct mode with SSL:
 160 .sp
 161 .if n \{\
 162 .RS 4
 163 .\}
 164 .nf
 165 [imap]
 166     folder = "INBOX\&.Drafts"
 167     host = imaps://imap\&.example\&.com
 168     user = bob
 169     pass = p4ssw0rd
 170     port = 123
 171     ; sslVerify = false
 172 .fi
 173 .if n \{\
 174 .RE
 175 .\}
 176 .sp
 177 .if n \{\
 178 .sp
 179 .\}
 180 .RS 4
 181 .it 1 an-trap
 182 .nr an-no-space-flag 1
 183 .nr an-break-flag 1
 184 .br
 185 .ps +1
 186 \fBNote\fR
 187 .ps -1
 188 .br
 189 .sp
 190 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\&.
 191 .sp .5v
 192 .RE
 193 .sp
 194 Using Gmail\(cqs IMAP interface:
 195 .sp
 196 .if n \{\
 197 .RS 4
 198 .\}
 199 .nf
 200 [imap]
 201         folder = "[Gmail]/Drafts"
 202         host = imaps://imap\&.gmail\&.com
 203         user = user@gmail\&.com
 204         port = 993
 205 .fi
 206 .if n \{\
 207 .RE
 208 .\}
 209 .sp
 210 .if n \{\
 211 .sp
 212 .\}
 213 .RS 4
 214 .it 1 an-trap
 215 .nr an-no-space-flag 1
 216 .nr an-break-flag 1
 217 .br
 218 .ps +1
 219 \fBNote\fR
 220 .ps -1
 221 .br
 222 .sp
 223 You might need to instead use: \fBfolder = "[Google Mail]/Drafts"\fR if you get an error that the "Folder doesn\(cqt exist"\&.
 224 .sp .5v
 225 .RE
 226 .if n \{\
 227 .sp
 228 .\}
 229 .RS 4
 230 .it 1 an-trap
 231 .nr an-no-space-flag 1
 232 .nr an-break-flag 1
 233 .br
 234 .ps +1
 235 \fBNote\fR
 236 .ps -1
 237 .br
 238 .sp
 239 If your Gmail account is set to another language than English, the name of the "Drafts" folder will be localized\&.
 240 .sp .5v
 241 .RE
 242 .sp
 243 Once the commits are ready to be sent, run the following command:
 244 .sp
 245 .if n \{\
 246 .RS 4
 247 .\}
 248 .nf
 249 $ git format\-patch \-\-cover\-letter \-M \-\-stdout origin/master | git imap\-send
 250 .fi
 251 .if n \{\
 252 .RE
 253 .\}
 254 .sp
 255 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)\&.
 256 .SH "CAUTION"
 257 .sp
 258 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\&.
 259 .sp
 260 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[]
 261 .SH "SEE ALSO"
 262 .sp
 263 \fBgit-format-patch\fR(1), \fBgit-send-email\fR(1), mbox(5)
 264 .SH "GIT"
 265 .sp
 266 Part of the \fBgit\fR(1) suite