mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
c82b0748e5
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>
116 lines
2.5 KiB
Text
116 lines
2.5 KiB
Text
git-imap-send(1)
|
|
================
|
|
|
|
NAME
|
|
----
|
|
git-imap-send - Send a collection of patches from stdin to an IMAP folder
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
'git imap-send'
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
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.
|
|
|
|
Typical usage is something like:
|
|
|
|
git format-patch --signoff --stdout --attach origin | git imap-send
|
|
|
|
|
|
CONFIGURATION
|
|
-------------
|
|
|
|
To use the tool, imap.folder and either imap.tunnel or imap.host must be set
|
|
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]
|
|
folder = "INBOX.Drafts"
|
|
tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
|
|
..........................
|
|
|
|
Using direct mode:
|
|
|
|
.........................
|
|
[imap]
|
|
folder = "INBOX.Drafts"
|
|
host = imap://imap.example.com
|
|
user = bob
|
|
pass = p4ssw0rd
|
|
..........................
|
|
|
|
Using direct mode with SSL:
|
|
|
|
.........................
|
|
[imap]
|
|
folder = "INBOX.Drafts"
|
|
host = imaps://imap.example.com
|
|
user = bob
|
|
pass = p4ssw0rd
|
|
port = 123
|
|
sslverify = false
|
|
..........................
|
|
|
|
|
|
BUGS
|
|
----
|
|
Doesn't handle lines starting with "From " in the message body.
|
|
|
|
|
|
Author
|
|
------
|
|
Derived from isync 1.0.1 by Mike McCormack.
|
|
|
|
Documentation
|
|
--------------
|
|
Documentation by Mike McCormack
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|