Document the configuration file
[git/dscho.git] / Documentation / git-imap-send.txt
blobcfc0d88d027dbf84a0e754387a9611076dc74489
1 git-imap-send(1)
2 ================
4 NAME
5 ----
6 git-imap-send - Dump a mailbox from stdin into 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 sent with 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 git-imap-send requires the following values in the repository
30 configuration file (shown with examples):
32 [imap]
33     Folder = "INBOX.Drafts"
35 [imap]
36     Tunnel = "ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null"
38 [imap]
39     Host = imap.server.com
40     User = bob
41     Password = pwd
42     Port = 143
45 BUGS
46 ----
47 Doesn't handle lines starting with "From " in the message body.
50 Author
51 ------
52 Derived from isync 1.0.1 by Mike McCormack.
54 Documentation
55 --------------
56 Documentation by Mike McCormack
58 GIT
59 ---
60 Part of the gitlink:git[7] suite