Merge branch 'cb/maint-orphan-merge-noclobber'
[git/kirr.git] / Documentation / git-imap-send.txt
blob57aba42e6654e3d32617c3c7b17d18e8dd85852b
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 imap.authMethod::
77         Specify authenticate method for authentication with IMAP server.
78         Current supported method is 'CRAM-MD5' only.
80 Examples
81 ~~~~~~~~
83 Using tunnel mode:
85 ..........................
86 [imap]
87     folder = "INBOX.Drafts"
88     tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
89 ..........................
91 Using direct mode:
93 .........................
94 [imap]
95     folder = "INBOX.Drafts"
96     host = imap://imap.example.com
97     user = bob
98     pass = p4ssw0rd
99 ..........................
101 Using direct mode with SSL:
103 .........................
104 [imap]
105     folder = "INBOX.Drafts"
106     host = imaps://imap.example.com
107     user = bob
108     pass = p4ssw0rd
109     port = 123
110     sslverify = false
111 ..........................
114 CAUTION
115 -------
116 It is still your responsibility to make sure that the email message
117 sent by your email program meets the standards of your project.
118 Many projects do not like patches to be attached.  Some mail
119 agents will transform patches (e.g. wrap lines, send them as
120 format=flowed) in ways that make them fail.  You will get angry
121 flames ridiculing you if you don't check this.
123 Thunderbird in particular is known to be problematic.  Thunderbird
124 users may wish to visit this web page for more information:
125   http://kb.mozillazine.org/Plain_text_e-mail_-_Thunderbird#Completely_plain_email
127 Author
128 ------
129 Derived from isync 1.0.1 by Mike McCormack.
131 Documentation
132 --------------
133 Documentation by Mike McCormack
137 Part of the linkgit:git[1] suite