doc/source/en/TortoiseGit/git_doc/git-imap-send.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-imap-send(1)">\r
   5     <title>git-imap-send(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-imap-send(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-imap-send(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-imap-send - Send a collection of patches from stdin to an IMAP folder</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-imap-send(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git imap-send</emphasis> [-v] [-q] [--[no-]curl]</literallayout>\r
  17 </blockquote>\r
  18 </simplesect>\r
  19 <simplesect id="git-imap-send(1)__description">\r
  20 <title>DESCRIPTION</title>\r
  21 <simpara>This command uploads a mailbox generated with <emphasis>git format-patch</emphasis>\r
  22 into an IMAP drafts folder.  This allows patches to be sent as\r
  23 other email is when using mail clients that cannot read mailbox\r
  24 files directly. The command also works with any general mailbox\r
  25 in which emails have the fields "From", "Date", and "Subject" in\r
  26 that order.</simpara>\r
  27 <simpara>Typical usage is something like:</simpara>\r
  28 <simpara>git format-patch --signoff --stdout --attach origin | git imap-send</simpara>\r
  29 </simplesect>\r
  30 <simplesect id="git-imap-send(1)__options">\r
  31 <title>OPTIONS</title>\r
  32 <variablelist>\r
  33 <varlistentry>\r
  34 <term>\r
  35 -v\r
  36 </term>\r
  37 <term>\r
  38 --verbose\r
  39 </term>\r
  40 <listitem>\r
  41 <simpara>\r
  42         Be verbose.\r
  43 </simpara>\r
  44 </listitem>\r
  45 </varlistentry>\r
  46 <varlistentry>\r
  47 <term>\r
  48 -q\r
  49 </term>\r
  50 <term>\r
  51 --quiet\r
  52 </term>\r
  53 <listitem>\r
  54 <simpara>\r
  55         Be quiet.\r
  56 </simpara>\r
  57 </listitem>\r
  58 </varlistentry>\r
  59 <varlistentry>\r
  60 <term>\r
  61 --curl\r
  62 </term>\r
  63 <listitem>\r
  64 <simpara>\r
  65         Use libcurl to communicate with the IMAP server, unless tunneling\r
  66         into it.  Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND\r
  67         option set.\r
  68 </simpara>\r
  69 </listitem>\r
  70 </varlistentry>\r
  71 <varlistentry>\r
  72 <term>\r
  73 --no-curl\r
  74 </term>\r
  75 <listitem>\r
  76 <simpara>\r
  77         Talk to the IMAP server using git's own IMAP routines instead of\r
  78         using libcurl.  Ignored if Git was built with the NO_OPENSSL option\r
  79         set.\r
  80 </simpara>\r
  81 </listitem>\r
  82 </varlistentry>\r
  83 </variablelist>\r
  84 </simplesect>\r
  85 <simplesect id="git-imap-send(1)__configuration">\r
  86 <title>CONFIGURATION</title>\r
  87 <simpara>To use the tool, imap.folder and either imap.tunnel or imap.host must be set\r
  88 to appropriate values.</simpara>\r
  89 <section id="git-imap-send(1)__variables">\r
  90 <title>Variables</title>\r
  91 <variablelist>\r
  92 <varlistentry>\r
  93 <term>\r
  94 imap.folder\r
  95 </term>\r
  96 <listitem>\r
  97 <simpara>\r
  98         The folder to drop the mails into, which is typically the Drafts\r
  99         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or\r
 100         "[Gmail]/Drafts". Required.\r
 101 </simpara>\r
 102 </listitem>\r
 103 </varlistentry>\r
 104 <varlistentry>\r
 105 <term>\r
 106 imap.tunnel\r
 107 </term>\r
 108 <listitem>\r
 109 <simpara>\r
 110         Command used to setup a tunnel to the IMAP server through which\r
 111         commands will be piped instead of using a direct network connection\r
 112         to the server. Required when imap.host is not set.\r
 113 </simpara>\r
 114 </listitem>\r
 115 </varlistentry>\r
 116 <varlistentry>\r
 117 <term>\r
 118 imap.host\r
 119 </term>\r
 120 <listitem>\r
 121 <simpara>\r
 122         A URL identifying the server. Use an <emphasis>imap://</emphasis> prefix for non-secure\r
 123         connections and an <emphasis>imaps://</emphasis> prefix for secure connections.\r
 124         Ignored when imap.tunnel is set, but required otherwise.\r
 125 </simpara>\r
 126 </listitem>\r
 127 </varlistentry>\r
 128 <varlistentry>\r
 129 <term>\r
 130 imap.user\r
 131 </term>\r
 132 <listitem>\r
 133 <simpara>\r
 134         The username to use when logging in to the server.\r
 135 </simpara>\r
 136 </listitem>\r
 137 </varlistentry>\r
 138 <varlistentry>\r
 139 <term>\r
 140 imap.pass\r
 141 </term>\r
 142 <listitem>\r
 143 <simpara>\r
 144         The password to use when logging in to the server.\r
 145 </simpara>\r
 146 </listitem>\r
 147 </varlistentry>\r
 148 <varlistentry>\r
 149 <term>\r
 150 imap.port\r
 151 </term>\r
 152 <listitem>\r
 153 <simpara>\r
 154         An integer port number to connect to on the server.\r
 155         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.\r
 156         Ignored when imap.tunnel is set.\r
 157 </simpara>\r
 158 </listitem>\r
 159 </varlistentry>\r
 160 <varlistentry>\r
 161 <term>\r
 162 imap.sslverify\r
 163 </term>\r
 164 <listitem>\r
 165 <simpara>\r
 166         A boolean to enable/disable verification of the server certificate\r
 167         used by the SSL/TLS connection. Default is <emphasis>true</emphasis>. Ignored when\r
 168         imap.tunnel is set.\r
 169 </simpara>\r
 170 </listitem>\r
 171 </varlistentry>\r
 172 <varlistentry>\r
 173 <term>\r
 174 imap.preformattedHTML\r
 175 </term>\r
 176 <listitem>\r
 177 <simpara>\r
 178         A boolean to enable/disable the use of html encoding when sending\r
 179         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;\r
 180         and have a content type of text/html.  Ironically, enabling this\r
 181         option causes Thunderbird to send the patch as a plain/text,\r
 182         format=fixed email.  Default is <emphasis>false</emphasis>.\r
 183 </simpara>\r
 184 </listitem>\r
 185 </varlistentry>\r
 186 <varlistentry>\r
 187 <term>\r
 188 imap.authMethod\r
 189 </term>\r
 190 <listitem>\r
 191 <simpara>\r
 192         Specify authenticate method for authentication with IMAP server.\r
 193         If Git was built with the NO_CURL option, or if your curl version is older\r
 194         than 7.34.0, or if you're running git-imap-send with the <emphasis>--no-curl</emphasis>\r
 195         option, the only supported method is <emphasis>CRAM-MD5</emphasis>. If this is not set\r
 196         then <emphasis>git imap-send</emphasis> uses the basic IMAP plaintext LOGIN command.\r
 197 </simpara>\r
 198 </listitem>\r
 199 </varlistentry>\r
 200 </variablelist>\r
 201 </section>\r
 202 <section id="git-imap-send(1)__examples">\r
 203 <title>Examples</title>\r
 204 <simpara>Using tunnel mode:</simpara>\r
 205 <literallayout class="monospaced">[imap]\r
 206     folder = "INBOX.Drafts"\r
 207     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</literallayout>\r
 208 <simpara>Using direct mode:</simpara>\r
 209 <literallayout class="monospaced">[imap]\r
 210     folder = "INBOX.Drafts"\r
 211     host = imap://imap.example.com\r
 212     user = bob\r
 213     pass = p4ssw0rd</literallayout>\r
 214 <simpara>Using direct mode with SSL:</simpara>\r
 215 <literallayout class="monospaced">[imap]\r
 216     folder = "INBOX.Drafts"\r
 217     host = imaps://imap.example.com\r
 218     user = bob\r
 219     pass = p4ssw0rd\r
 220     port = 123\r
 221     sslverify = false</literallayout>\r
 222 </section>\r
 223 </simplesect>\r
 224 <simplesect id="git-imap-send(1)__examples_2">\r
 225 <title>EXAMPLES</title>\r
 226 <simpara>To submit patches using GMail's IMAP interface, first, edit your ~/.gitconfig\r
 227 to specify your account settings:</simpara>\r
 228 <screen>[imap]\r
 229         folder = "[Gmail]/Drafts"\r
 230         host = imaps://imap.gmail.com\r
 231         user = user@gmail.com\r
 232         port = 993\r
 233         sslverify = false</screen>\r
 234 <simpara>You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error\r
 235 that the "Folder doesn't exist".</simpara>\r
 236 <simpara>Once the commits are ready to be sent, run the following command:</simpara>\r
 237 <literallayout class="monospaced">$ git format-patch --cover-letter -M --stdout origin/master | git imap-send</literallayout>\r
 238 <simpara>Just make sure to disable line wrapping in the email client (GMail's web\r
 239 interface will wrap lines no matter what, so you need to use a real\r
 240 IMAP client).</simpara>\r
 241 </simplesect>\r
 242 <simplesect id="git-imap-send(1)__caution">\r
 243 <title>CAUTION</title>\r
 244 <simpara>It is still your responsibility to make sure that the email message\r
 245 sent by your email program meets the standards of your project.\r
 246 Many projects do not like patches to be attached.  Some mail\r
 247 agents will transform patches (e.g. wrap lines, send them as\r
 248 format=flowed) in ways that make them fail.  You will get angry\r
 249 flames ridiculing you if you don't check this.</simpara>\r
 250 <simpara>Thunderbird in particular is known to be problematic.  Thunderbird\r
 251 users may wish to visit this web page for more information:\r
 252   <ulink url="http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email">http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email</ulink></simpara>\r
 253 </simplesect>\r
 254 <simplesect id="git-imap-send(1)__see_also">\r
 255 <title>SEE ALSO</title>\r
 256 <simpara><xref linkend="git-format-patch(1)" />, <xref linkend="git-send-email(1)" />, mbox(5)</simpara>\r
 257 </simplesect>\r
 258 <simplesect id="git-imap-send(1)__git">\r
 259 <title>GIT</title>\r
 260 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 261 </simplesect>\r
 262 </sect2>\r