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

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/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 <simpara><emphasis>git imap-send</emphasis></simpara>\r
  18 </simplesect>\r
  19 <simplesect id="_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.</simpara>\r
  25 <simpara>Typical usage is something like:</simpara>\r
  26 <simpara>git format-patch --signoff --stdout --attach origin | git imap-send</simpara>\r
  27 </simplesect>\r
  28 <simplesect id="_configuration">\r
  29 <title>CONFIGURATION</title>\r
  30 <simpara>To use the tool, imap.folder and either imap.tunnel or imap.host must be set\r
  31 to appropriate values.</simpara>\r
  32 <simplesect id="_variables">\r
  33 <title>Variables</title>\r
  34 <variablelist>\r
  35 <varlistentry>\r
  36 <term>\r
  37 imap.folder\r
  38 </term>\r
  39 <listitem>\r
  40 <simpara>\r
  41         The folder to drop the mails into, which is typically the Drafts\r
  42         folder. For example: "INBOX.Drafts", "INBOX/Drafts" or\r
  43         "[Gmail]/Drafts". Required to use imap-send.\r
  44 </simpara>\r
  45 </listitem>\r
  46 </varlistentry>\r
  47 <varlistentry>\r
  48 <term>\r
  49 imap.tunnel\r
  50 </term>\r
  51 <listitem>\r
  52 <simpara>\r
  53         Command used to setup a tunnel to the IMAP server through which\r
  54         commands will be piped instead of using a direct network connection\r
  55         to the server. Required when imap.host is not set to use imap-send.\r
  56 </simpara>\r
  57 </listitem>\r
  58 </varlistentry>\r
  59 <varlistentry>\r
  60 <term>\r
  61 imap.host\r
  62 </term>\r
  63 <listitem>\r
  64 <simpara>\r
  65         A URL identifying the server. Use a <literal>imap://</literal> prefix for non-secure\r
  66         connections and a <literal>imaps://</literal> prefix for secure connections.\r
  67         Ignored when imap.tunnel is set, but required to use imap-send\r
  68         otherwise.\r
  69 </simpara>\r
  70 </listitem>\r
  71 </varlistentry>\r
  72 <varlistentry>\r
  73 <term>\r
  74 imap.user\r
  75 </term>\r
  76 <listitem>\r
  77 <simpara>\r
  78         The username to use when logging in to the server.\r
  79 </simpara>\r
  80 </listitem>\r
  81 </varlistentry>\r
  82 <varlistentry>\r
  83 <term>\r
  84 imap.password\r
  85 </term>\r
  86 <listitem>\r
  87 <simpara>\r
  88         The password to use when logging in to the server.\r
  89 </simpara>\r
  90 </listitem>\r
  91 </varlistentry>\r
  92 <varlistentry>\r
  93 <term>\r
  94 imap.port\r
  95 </term>\r
  96 <listitem>\r
  97 <simpara>\r
  98         An integer port number to connect to on the server.\r
  99         Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.\r
 100         Ignored when imap.tunnel is set.\r
 101 </simpara>\r
 102 </listitem>\r
 103 </varlistentry>\r
 104 <varlistentry>\r
 105 <term>\r
 106 imap.sslverify\r
 107 </term>\r
 108 <listitem>\r
 109 <simpara>\r
 110         A boolean to enable/disable verification of the server certificate\r
 111         used by the SSL/TLS connection. Default is <literal>true</literal>. Ignored when\r
 112         imap.tunnel is set.\r
 113 </simpara>\r
 114 </listitem>\r
 115 </varlistentry>\r
 116 </variablelist>\r
 117 </simplesect>\r
 118 <simplesect id="_examples">\r
 119 <title>Examples</title>\r
 120 <simpara>Using tunnel mode:</simpara>\r
 121 <literallayout class="monospaced">[imap]\r
 122     folder = "INBOX.Drafts"\r
 123     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</literallayout>\r
 124 <simpara>Using direct mode:</simpara>\r
 125 <literallayout class="monospaced">[imap]\r
 126     folder = "INBOX.Drafts"\r
 127     host = imap://imap.example.com\r
 128     user = bob\r
 129     pass = p4ssw0rd</literallayout>\r
 130 <simpara>Using direct mode with SSL:</simpara>\r
 131 <literallayout class="monospaced">[imap]\r
 132     folder = "INBOX.Drafts"\r
 133     host = imaps://imap.example.com\r
 134     user = bob\r
 135     pass = p4ssw0rd\r
 136     port = 123\r
 137     sslverify = false</literallayout>\r
 138 </simplesect>\r
 139 </simplesect>\r
 140 <simplesect id="_bugs">\r
 141 <title>BUGS</title>\r
 142 <simpara>Doesn&#8217;t handle lines starting with "From " in the message body.</simpara>\r
 143 </simplesect>\r
 144 <simplesect id="_author">\r
 145 <title>Author</title>\r
 146 <simpara>Derived from isync 1.0.1 by Mike McCormack.</simpara>\r
 147 </simplesect>\r
 148 <simplesect id="_documentation">\r
 149 <title>Documentation</title>\r
 150 <simpara>Documentation by Mike McCormack</simpara>\r
 151 </simplesect>\r
 152 <simplesect id="_git">\r
 153 <title>GIT</title>\r
 154 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 155 </simplesect>\r
 156 </article>\r