kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Documentation: Improve documentation for git-imap-send(1) 

Change the description to be similar to that used for git-send-email(1) to
give a better description of what the tool can be used for and sound more
user-friendly.

Document the configuration variables used by git-imap-send, split the
example into tunnel and direct examples. Rephrase other parts of the
git-imap-send documentation to use better grammar and to be clearer.

Signed-off-by: Robert Shearman <robertshearman@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Robert Shearman 2008-07-09 22:29:02 +01:00 committed by Junio C Hamano
parent 9f1ad541f9
commit c82b0748e5
1 changed files with 66 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
Documentation/git-imap-send.txt
View File

@ -3,7 +3,7 @@ git-imap-send(1)


NAME NAME
---- ----
git-imap-send - Dump a mailbox from stdin into an imap folder git-imap-send - Send a collection of patches from stdin to an IMAP folder




SYNOPSIS SYNOPSIS
@ -13,9 +13,9 @@ 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 into an IMAP drafts folder. This allows patches to be sent as
other email is sent with mail clients that cannot read mailbox other email is when using mail clients that cannot read mailbox
files directly. files directly.


Typical usage is something like: Typical usage is something like:
@ -26,21 +26,74 @@ git format-patch --signoff --stdout --attach origin | git imap-send
CONFIGURATION CONFIGURATION
------------- -------------


'git-imap-send' requires the following values in the repository To use the tool, imap.folder and either imap.tunnel or imap.host must be set
configuration file (shown with examples): to appropriate values.

Variables
~~~~~~~~~

imap.folder::
The folder to drop the mails into, which is typically the Drafts
folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
"[Gmail]/Drafts". Required to use imap-send.

imap.tunnel::
Command used to setup 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 to use imap-send.

imap.host::
A URL identifying the server. Use a `imap://` prefix for non-secure
connections and a `imaps://` prefix for secure connections.
Ignored when imap.tunnel is set, but required to use imap-send
otherwise.

imap.user::
The username to use when logging in to the server.

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

imap.port::
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.

imap.sslverify::
A boolean to enable/disable verification of the server certificate
used by the SSL/TLS connection. Default is `true`. Ignored when
imap.tunnel is set.

Examples
~~~~~~~~

Using tunnel mode:


.......................... ..........................
[imap] [imap]
Folder = "INBOX.Drafts" folder = "INBOX.Drafts"
tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
..........................


[imap] Using direct mode:
Tunnel = "ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null"


.........................
[imap] [imap]
Host = imap://imap.example.com folder = "INBOX.Drafts"
User = bob host = imap://imap.example.com
Pass = pwd user = bob
Port = 143 pass = p4ssw0rd
..........................

Using direct mode with SSL:

.........................
[imap]
folder = "INBOX.Drafts"
host = imaps://imap.example.com
user = bob
pass = p4ssw0rd
port = 123
sslverify = false sslverify = false
.......................... ..........................