summaryrefslogtreecommitdiff
path: root/Documentation/git-imap-send.txt
blob: bd49a0aee8881f983077d74bd8d0fbe5764dfea5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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