Documentation: Spelling fix
[git/dscho.git] / Documentation / git-imap-send.txt
blobbd49a0aee8881f983077d74bd8d0fbe5764dfea5
1 git-imap-send(1)
2 ================
4 NAME
5 ----
6 git-imap-send - Send a collection of patches from stdin to an IMAP folder
9 SYNOPSIS
10 --------
11 'git imap-send'
14 DESCRIPTION
15 -----------
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
19 files directly.
21 Typical usage is something like:
23 git format-patch --signoff --stdout --attach origin | git imap-send
26 CONFIGURATION
27 -------------
29 To use the tool, imap.folder and either imap.tunnel or imap.host must be set
30 to appropriate values.
32 Variables
33 ~~~~~~~~~
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.
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.
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.
51 imap.user::
52         The username to use when logging in to the server.
54 imap.password::
55         The password to use when logging in to the server.
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.
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.
67 Examples
68 ~~~~~~~~
70 Using tunnel mode:
72 ..........................
73 [imap]
74     folder = "INBOX.Drafts"
75     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
76 ..........................
78 Using direct mode:
80 .........................
81 [imap]
82     folder = "INBOX.Drafts"
83     host = imap://imap.example.com
84     user = bob
85     pass = p4ssw0rd
86 ..........................
88 Using direct mode with SSL:
90 .........................
91 [imap]
92     folder = "INBOX.Drafts"
93     host = imaps://imap.example.com
94     user = bob
95     pass = p4ssw0rd
96     port = 123
97     sslverify = false
98 ..........................
101 BUGS
102 ----
103 Doesn't handle lines starting with "From " in the message body.
106 Author
107 ------
108 Derived from isync 1.0.1 by Mike McCormack.
110 Documentation
111 --------------
112 Documentation by Mike McCormack
116 Part of the linkgit:git[1] suite