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

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-imap-send(1)">\r
   5 <articleinfo>\r
   6     <title>git-imap-send(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-imap-send(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-imap-send - Send a collection of patches from stdin to an IMAP folder</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git imap-send</emphasis></literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="_description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>This command uploads a mailbox generated with <emphasis>git format-patch</emphasis>\r
  24 into an IMAP drafts folder.  This allows patches to be sent as\r
  25 other email is when using mail clients that cannot read mailbox\r
  26 files directly. The command also works with any general mailbox\r
  27 in which emails have the fields "From", "Date", and "Subject" in\r
  28 that order.</simpara>\r
  29 <simpara>Typical usage is something like:</simpara>\r
  30 <simpara>git format-patch --signoff --stdout --attach origin | git imap-send</simpara>\r
  31 </simplesect>\r
  32 <simplesect id="_configuration">\r
  33 <title>CONFIGURATION</title>\r
  34 <simpara>To use the tool, imap.folder and either imap.tunnel or imap.host must be set\r
  35 to appropriate values.</simpara>\r
  36 <section id="_variables">\r
  37 <title>Variables</title>\r
  38 <variablelist>\r
  39 <varlistentry>\r
  40 <term>\r
  41 imap.folder\r
  42 </term>\r
  43 <listitem>\r
  44 <simpara>\r
  45         The folder to drop the mails into, which is typically the Drafts\r
  46         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or\r
  47         "[Gmail]/Drafts". Required to use imap-send.\r
  48 </simpara>\r
  49 </listitem>\r
  50 </varlistentry>\r
  51 <varlistentry>\r
  52 <term>\r
  53 imap.tunnel\r
  54 </term>\r
  55 <listitem>\r
  56 <simpara>\r
  57         Command used to setup a tunnel to the IMAP server through which\r
  58         commands will be piped instead of using a direct network connection\r
  59         to the server. Required when imap.host is not set to use imap-send.\r
  60 </simpara>\r
  61 </listitem>\r
  62 </varlistentry>\r
  63 <varlistentry>\r
  64 <term>\r
  65 imap.host\r
  66 </term>\r
  67 <listitem>\r
  68 <simpara>\r
  69         A URL identifying the server. Use a <emphasis>imap://</emphasis> prefix for non-secure\r
  70         connections and a <emphasis>imaps://</emphasis> prefix for secure connections.\r
  71         Ignored when imap.tunnel is set, but required to use imap-send\r
  72         otherwise.\r
  73 </simpara>\r
  74 </listitem>\r
  75 </varlistentry>\r
  76 <varlistentry>\r
  77 <term>\r
  78 imap.user\r
  79 </term>\r
  80 <listitem>\r
  81 <simpara>\r
  82         The username to use when logging in to the server.\r
  83 </simpara>\r
  84 </listitem>\r
  85 </varlistentry>\r
  86 <varlistentry>\r
  87 <term>\r
  88 imap.pass\r
  89 </term>\r
  90 <listitem>\r
  91 <simpara>\r
  92         The password to use when logging in to the server.\r
  93 </simpara>\r
  94 </listitem>\r
  95 </varlistentry>\r
  96 <varlistentry>\r
  97 <term>\r
  98 imap.port\r
  99 </term>\r
 100 <listitem>\r
 101 <simpara>\r
 102         An integer port number to connect to on the server.\r
 103         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.\r
 104         Ignored when imap.tunnel is set.\r
 105 </simpara>\r
 106 </listitem>\r
 107 </varlistentry>\r
 108 <varlistentry>\r
 109 <term>\r
 110 imap.sslverify\r
 111 </term>\r
 112 <listitem>\r
 113 <simpara>\r
 114         A boolean to enable/disable verification of the server certificate\r
 115         used by the SSL/TLS connection. Default is <emphasis>true</emphasis>. Ignored when\r
 116         imap.tunnel is set.\r
 117 </simpara>\r
 118 </listitem>\r
 119 </varlistentry>\r
 120 <varlistentry>\r
 121 <term>\r
 122 imap.preformattedHTML\r
 123 </term>\r
 124 <listitem>\r
 125 <simpara>\r
 126         A boolean to enable/disable the use of html encoding when sending\r
 127         a patch.  An html encoded patch will be bracketed with &lt;pre&gt;\r
 128         and have a content type of text/html.  Ironically, enabling this\r
 129         option causes Thunderbird to send the patch as a plain/text,\r
 130         format=fixed email.  Default is <emphasis>false</emphasis>.\r
 131 </simpara>\r
 132 </listitem>\r
 133 </varlistentry>\r
 134 <varlistentry>\r
 135 <term>\r
 136 imap.authMethod\r
 137 </term>\r
 138 <listitem>\r
 139 <simpara>\r
 140         Specify authenticate method for authentication with IMAP server.\r
 141         Current supported method is <emphasis>CRAM-MD5</emphasis> only.\r
 142 </simpara>\r
 143 </listitem>\r
 144 </varlistentry>\r
 145 </variablelist>\r
 146 </section>\r
 147 <section id="_examples">\r
 148 <title>Examples</title>\r
 149 <simpara>Using tunnel mode:</simpara>\r
 150 <literallayout class="monospaced">[imap]\r
 151     folder = "INBOX.Drafts"\r
 152     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</literallayout>\r
 153 <simpara>Using direct mode:</simpara>\r
 154 <literallayout class="monospaced">[imap]\r
 155     folder = "INBOX.Drafts"\r
 156     host = imap://imap.example.com\r
 157     user = bob\r
 158     pass = p4ssw0rd</literallayout>\r
 159 <simpara>Using direct mode with SSL:</simpara>\r
 160 <literallayout class="monospaced">[imap]\r
 161     folder = "INBOX.Drafts"\r
 162     host = imaps://imap.example.com\r
 163     user = bob\r
 164     pass = p4ssw0rd\r
 165     port = 123\r
 166     sslverify = false</literallayout>\r
 167 </section>\r
 168 </simplesect>\r
 169 <simplesect id="_example">\r
 170 <title>EXAMPLE</title>\r
 171 <simpara>To submit patches using GMail's IMAP interface, first, edit your ~/.gitconfig\r
 172 to specify your account settings:</simpara>\r
 173 <screen>[imap]\r
 174         folder = "[Gmail]/Drafts"\r
 175         host = imaps://imap.gmail.com\r
 176         user = user@gmail.com\r
 177         port = 993\r
 178         sslverify = false</screen>\r
 179 <simpara>You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error\r
 180 that the "Folder doesn't exist".</simpara>\r
 181 <simpara>Once the commits are ready to be sent, run the following command:</simpara>\r
 182 <literallayout class="monospaced">$ git format-patch --cover-letter -M --stdout origin/master | git imap-send</literallayout>\r
 183 <simpara>Just make sure to disable line wrapping in the email client (GMail's web\r
 184 interface will wrap lines no matter what, so you need to use a real\r
 185 IMAP client).</simpara>\r
 186 </simplesect>\r
 187 <simplesect id="_caution">\r
 188 <title>CAUTION</title>\r
 189 <simpara>It is still your responsibility to make sure that the email message\r
 190 sent by your email program meets the standards of your project.\r
 191 Many projects do not like patches to be attached.  Some mail\r
 192 agents will transform patches (e.g. wrap lines, send them as\r
 193 format=flowed) in ways that make them fail.  You will get angry\r
 194 flames ridiculing you if you don't check this.</simpara>\r
 195 <simpara>Thunderbird in particular is known to be problematic.  Thunderbird\r
 196 users may wish to visit this web page for more information:\r
 197   <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
 198 </simplesect>\r
 199 <simplesect id="_see_also">\r
 200 <title>SEE ALSO</title>\r
 201 <simpara><xref linkend="git-format-patch(1)" />, <xref linkend="git-send-email(1)" />, mbox(5)</simpara>\r
 202 </simplesect>\r
 203 <simplesect id="_git">\r
 204 <title>GIT</title>\r
 205 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 206 </simplesect>\r
 207 </article>\r