Merge branch 'il/remote-updates'

[git.git] / Documentation / git-imap-send.txt

diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index bd49a0aee8881f983077d74bd8d0fbe5764dfea5..57db955bd4cc82f643ed5b932b33d440d8cf409a 100644 (file)
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -13,7 +13,7 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

-This command uploads a mailbox generated with 'git-format-patch'
+This command uploads a mailbox generated with 'git format-patch'

 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.
 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.


@@ -51,7 +51,7 @@ imap.host::
 imap.user::
        The username to use when logging in to the server.
 
 imap.user::
        The username to use when logging in to the server.
 

-imap.password::
+imap.pass::

        The password to use when logging in to the server.
 
 imap.port::
        The password to use when logging in to the server.
 
 imap.port::


@@ -64,6 +64,13 @@ imap.sslverify::
        used by the SSL/TLS connection. Default is `true`. Ignored when
        imap.tunnel is set.
 
        used by the SSL/TLS connection. Default is `true`. Ignored when
        imap.tunnel is set.
 

+imap.preformattedHTML::
+       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 `false`.
+

 Examples
 ~~~~~~~~
 
 Examples
 ~~~~~~~~
 


@@ -98,6 +105,20 @@ Using direct mode with SSL:
 ..........................
 
 
 ..........................
 
 

+CAUTION
+-------
+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.
+
+Thunderbird in particular is known to be problematic.  Thunderbird
+users may wish to visit this web page for more information:
+  http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
+
+

 BUGS
 ----
 Doesn't handle lines starting with "From " in the message body.
 BUGS
 ----
 Doesn't handle lines starting with "From " in the message body.