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. The command also works with any general mailbox
20 in which emails have the fields "From", "Date", and "Subject" in
21 that order.
23 Typical usage is something like:
25 git format-patch --signoff --stdout --attach origin | git imap-send
28 CONFIGURATION
29 -------------
31 To use the tool, imap.folder and either imap.tunnel or imap.host must be set
32 to appropriate values.
34 Variables
35 ~~~~~~~~~
37 imap.folder::
38 The folder to drop the mails into, which is typically the Drafts
39 folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
40 "[Gmail]/Drafts". Required to use imap-send.
42 imap.tunnel::
43 Command used to setup a tunnel to the IMAP server through which
44 commands will be piped instead of using a direct network connection
45 to the server. Required when imap.host is not set to use imap-send.
47 imap.host::
48 A URL identifying the server. Use a `imap://` prefix for non-secure
49 connections and a `imaps://` prefix for secure connections.
50 Ignored when imap.tunnel is set, but required to use imap-send
51 otherwise.
53 imap.user::
54 The username to use when logging in to the server.
56 imap.pass::
57 The password to use when logging in to the server.
59 imap.port::
60 An integer port number to connect to on the server.
61 Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
62 Ignored when imap.tunnel is set.
64 imap.sslverify::
65 A boolean to enable/disable verification of the server certificate
66 used by the SSL/TLS connection. Default is `true`. Ignored when
67 imap.tunnel is set.
69 imap.preformattedHTML::
70 A boolean to enable/disable the use of html encoding when sending
71 a patch. An html encoded patch will be bracketed with <pre>
72 and have a content type of text/html. Ironically, enabling this
73 option causes Thunderbird to send the patch as a plain/text,
74 format=fixed email. Default is `false`.
76 Examples
77 ~~~~~~~~
79 Using tunnel mode:
81 ..........................
82 [imap]
83 folder = "INBOX.Drafts"
84 tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
85 ..........................
87 Using direct mode:
89 .........................
90 [imap]
91 folder = "INBOX.Drafts"
92 host = imap://imap.example.com
93 user = bob
94 pass = p4ssw0rd
95 ..........................
97 Using direct mode with SSL:
99 .........................
100 [imap]
101 folder = "INBOX.Drafts"
102 host = imaps://imap.example.com
103 user = bob
104 pass = p4ssw0rd
105 port = 123
106 sslverify = false
107 ..........................
110 CAUTION
111 -------
112 It is still your responsibility to make sure that the email message
113 sent by your email program meets the standards of your project.
114 Many projects do not like patches to be attached. Some mail
115 agents will transform patches (e.g. wrap lines, send them as
116 format=flowed) in ways that make them fail. You will get angry
117 flames ridiculing you if you don't check this.
119 Thunderbird in particular is known to be problematic. Thunderbird
120 users may wish to visit this web page for more information:
121 http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
123 Author
124 ------
125 Derived from isync 1.0.1 by Mike McCormack.
127 Documentation
128 --------------
129 Documentation by Mike McCormack
131 GIT
132 ---
133 Part of the linkgit:git[1] suite