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

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
Commit	Line	Data
454a35b8 MM	1	git-imap-send(1)
	2	================
	3
	4	NAME
	5	----
c82b0748	6	git-imap-send - Send a collection of patches from stdin to an IMAP folder
454a35b8 MM	7
	8
	9	SYNOPSIS
	10	--------
b1889c36	11	'git imap-send'
454a35b8 MM	12
	13
	14	DESCRIPTION
	15	-----------
c82b0748 RS	16	This command uploads a mailbox generated with 'git-format-patch'
	17	into an IMAP drafts folder. This allows patches to be sent as
	18	other email is when using mail clients that cannot read mailbox
454a35b8 MM	19	files directly.
	20
	21	Typical usage is something like:
	22
b1889c36	23	git format-patch --signoff --stdout --attach origin \| git imap-send
454a35b8 MM	24
	25
	26	CONFIGURATION
	27	-------------
	28
c82b0748 RS	29	To use the tool, imap.folder and either imap.tunnel or imap.host must be set
	30	to appropriate values.
	31
	32	Variables
	33	~~~~~~~~~
	34
	35	imap.folder::
	36	The folder to drop the mails into, which is typically the Drafts
	37	folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
	38	"[Gmail]/Drafts". Required to use imap-send.
	39
	40	imap.tunnel::
	41	Command used to setup a tunnel to the IMAP server through which
	42	commands will be piped instead of using a direct network connection
	43	to the server. Required when imap.host is not set to use imap-send.
	44
	45	imap.host::
	46	A URL identifying the server. Use a `imap://` prefix for non-secure
	47	connections and a `imaps://` prefix for secure connections.
	48	Ignored when imap.tunnel is set, but required to use imap-send
	49	otherwise.
	50
	51	imap.user::
	52	The username to use when logging in to the server.
	53
	54	imap.password::
	55	The password to use when logging in to the server.
	56
	57	imap.port::
	58	An integer port number to connect to on the server.
	59	Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
	60	Ignored when imap.tunnel is set.
	61
	62	imap.sslverify::
	63	A boolean to enable/disable verification of the server certificate
	64	used by the SSL/TLS connection. Default is `true`. Ignored when
	65	imap.tunnel is set.
	66
	67	Examples
	68	~~~~~~~~
	69
	70	Using tunnel mode:
454a35b8	71
2b5f3ed3	72	..........................
454a35b8	73	[imap]
c82b0748 RS	74	folder = "INBOX.Drafts"
	75	tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
	76	..........................
454a35b8	77
c82b0748 RS	78	Using direct mode:
	79
	80	.........................
454a35b8	81	[imap]
c82b0748 RS	82	folder = "INBOX.Drafts"
	83	host = imap://imap.example.com
	84	user = bob
	85	pass = p4ssw0rd
	86	..........................
	87
	88	Using direct mode with SSL:
454a35b8	89
c82b0748	90	.........................
454a35b8	91	[imap]
c82b0748 RS	92	folder = "INBOX.Drafts"
	93	host = imaps://imap.example.com
	94	user = bob
	95	pass = p4ssw0rd
	96	port = 123
684ec6c6	97	sslverify = false
2b5f3ed3	98	..........................
454a35b8 MM	99
	100
	101	BUGS
	102	----
	103	Doesn't handle lines starting with "From " in the message body.
	104
	105
	106	Author
	107	------
	108	Derived from isync 1.0.1 by Mike McCormack.
	109
	110	Documentation
	111	--------------
	112	Documentation by Mike McCormack
	113
	114	GIT
	115	---
9e1f0a85	116	Part of the linkgit:git[1] suite