summaryrefslogtreecommitdiff
path: root/devdocs/git/git-imap-send.html
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
committerCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
commit754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch)
treef1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/git/git-imap-send.html
new repository
Diffstat (limited to 'devdocs/git/git-imap-send.html')
-rw-r--r--devdocs/git/git-imap-send.html22
1 files changed, 22 insertions, 0 deletions
diff --git a/devdocs/git/git-imap-send.html b/devdocs/git/git-imap-send.html
new file mode 100644
index 00000000..7d30962d
--- /dev/null
+++ b/devdocs/git/git-imap-send.html
@@ -0,0 +1,22 @@
+<h1>git-imap-send</h1> <h2 id="_name">Name</h2> <div class="sectionbody"> <p>git-imap-send - Send a collection of patches from stdin to an IMAP folder</p> </div> <h2 id="_synopsis">Synopsis</h2> <div class="sectionbody"> <div class="verseblock"> <pre class="content" data-language="shell">git imap-send [-v] [-q] [--[no-]curl]</pre> </div> </div> <h2 id="_description">Description</h2> <div class="sectionbody"> <p>This command uploads a mailbox generated with <code>git format-patch</code> 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.</p> <p>Typical usage is something like:</p> <p>git format-patch --signoff --stdout --attach origin | git imap-send</p> </div> <h2 id="_options">Options</h2> <div class="sectionbody"> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-imap-send.txt--v"> -v </dt> <dt class="hdlist1" id="Documentation/git-imap-send.txt---verbose"> --verbose </dt> <dd> <p>Be verbose.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt--q"> -q </dt> <dt class="hdlist1" id="Documentation/git-imap-send.txt---quiet"> --quiet </dt> <dd> <p>Be quiet.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt---curl"> --curl </dt> <dd> <p>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.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt---no-curl"> --no-curl </dt> <dd> <p>Talk to the IMAP server using git’s own IMAP routines instead of using libcurl. Ignored if Git was built with the NO_OPENSSL option set.</p> </dd> </dl> </div> </div> <h2 id="_configuration">Configuration</h2> <div class="sectionbody"> <p>To use the tool, <code>imap.folder</code> and either <code>imap.tunnel</code> or <code>imap.host</code> must be set to appropriate values.</p> <p>Everything above this line in this section isn’t included from the <a href="git-config">git-config[1]</a> documentation. The content that follows is the same as what’s found there:</p> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imapfolder"> imap.folder </dt> <dd> <p>The folder to drop the mails into, which is typically the Drafts folder. For example: "INBOX.Drafts", "INBOX/Drafts" or "[Gmail]/Drafts". Required.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imaptunnel"> imap.tunnel </dt> <dd> <p>Command used to set up 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.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imaphost"> imap.host </dt> <dd> <p>A URL identifying the server. Use an <code>imap://</code> prefix for non-secure connections and an <code>imaps://</code> prefix for secure connections. Ignored when imap.tunnel is set, but required otherwise.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imapuser"> imap.user </dt> <dd> <p>The username to use when logging in to the server.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imappass"> imap.pass </dt> <dd> <p>The password to use when logging in to the server.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imapport"> imap.port </dt> <dd> <p>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.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imapsslverify"> imap.sslverify </dt> <dd> <p>A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection. Default is <code>true</code>. Ignored when imap.tunnel is set.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imappreformattedHTML"> imap.preformattedHTML </dt> <dd> <p>A boolean to enable/disable the use of html encoding when sending a patch. An html encoded patch will be bracketed with &lt;pre&gt; 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 <code>false</code>.</p> </dd> <dt class="hdlist1" id="Documentation/git-imap-send.txt-imapauthMethod"> imap.authMethod </dt> <dd> <p>Specify the authentication method for authenticating with the 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’re running git-imap-send with the <code>--no-curl</code> option, the only supported method is <code>CRAM-MD5</code>. If this is not set then <code>git imap-send</code> uses the basic IMAP plaintext LOGIN command.</p> </dd> </dl> </div> </div> <h2 id="_examples">Examples</h2> <div class="sectionbody"> <p>Using tunnel mode:</p> <div class="literalblock"> <div class="content"> <pre>[imap]
+ folder = "INBOX.Drafts"
+ tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2&gt; /dev/null"</pre> </div> </div> <p>Using direct mode:</p> <div class="literalblock"> <div class="content"> <pre>[imap]
+ folder = "INBOX.Drafts"
+ host = imap://imap.example.com
+ user = bob
+ pass = p4ssw0rd</pre> </div> </div> <p>Using direct mode with SSL:</p> <div class="literalblock"> <div class="content"> <pre>[imap]
+ folder = "INBOX.Drafts"
+ host = imaps://imap.example.com
+ user = bob
+ pass = p4ssw0rd
+ port = 123
+ ; sslVerify = false</pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> You may want to use <code>sslVerify=false</code> while troubleshooting, if you suspect that the reason you are having trouble connecting is because the certificate you use at the private server <code>example.com</code> you are trying to set up (or have set up) may not be verified correctly. </td> </tr> </table> </div> <p>Using Gmail’s IMAP interface:</p> <div class="listingblock"> <div class="content"> <pre>[imap]
+ folder = "[Gmail]/Drafts"
+ host = imaps://imap.gmail.com
+ user = user@gmail.com
+ port = 993</pre> </div> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> You might need to instead use: <code>folder = "[Google Mail]/Drafts"</code> if you get an error that the "Folder doesn’t exist". </td> </tr> </table> </div> <div class="admonitionblock note"> <table> <tr> <td class="icon"> <div class="title">Note</div> </td> <td class="content"> If your Gmail account is set to another language than English, the name of the "Drafts" folder will be localized. </td> </tr> </table> </div> <p>Once the commits are ready to be sent, run the following command:</p> <div class="literalblock"> <div class="content"> <pre data-language="shell-session">$ git format-patch --cover-letter -M --stdout origin/master | git imap-send</pre> </div> </div> <p>Just make sure to disable line wrapping in the email client (Gmail’s web interface will wrap lines no matter what, so you need to use a real IMAP client).</p> </div> <h2 id="_caution">Caution</h2> <div class="sectionbody"> <p>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’t check this.</p> <p>Thunderbird in particular is known to be problematic. Thunderbird users may wish to visit this web page for more information: <a href="https://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email" class="bare">https://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email</a></p> </div> <h2 id="_see_also">See also</h2> <div class="sectionbody"> <p><a href="git-format-patch">git-format-patch[1]</a>, <a href="git-send-email">git-send-email[1]</a>, mbox(5)</p> </div><div class="_attribution">
+ <p class="_attribution-p">
+ &copy; 2012&ndash;2024 Scott Chacon and others<br>Licensed under the MIT License.<br>
+ <a href="https://git-scm.com/docs/git-imap-send" class="_attribution-link">https://git-scm.com/docs/git-imap-send</a>
+ </p>
+</div>