]>
Commit | Line | Data |
---|---|---|
454a35b8 MM |
1 | git-imap-send(1) |
2 | ================ | |
3 | ||
4 | NAME | |
5 | ---- | |
c82b0748 | 6 | git-imap-send - Send a collection of patches from stdin to an IMAP folder |
454a35b8 MM |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
b1889c36 | 11 | 'git imap-send' |
454a35b8 MM |
12 | |
13 | ||
14 | DESCRIPTION | |
15 | ----------- | |
0b444cdb | 16 | This command uploads a mailbox generated with 'git format-patch' |
c82b0748 RS |
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 | |
4916c8f9 RR |
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. | |
454a35b8 MM |
22 | |
23 | Typical usage is something like: | |
24 | ||
b1889c36 | 25 | git format-patch --signoff --stdout --attach origin | git imap-send |
454a35b8 MM |
26 | |
27 | ||
28 | CONFIGURATION | |
29 | ------------- | |
30 | ||
c82b0748 RS |
31 | To use the tool, imap.folder and either imap.tunnel or imap.host must be set |
32 | to appropriate values. | |
33 | ||
34 | Variables | |
35 | ~~~~~~~~~ | |
36 | ||
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. | |
41 | ||
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. | |
46 | ||
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. | |
52 | ||
53 | imap.user:: | |
54 | The username to use when logging in to the server. | |
55 | ||
43be7a78 | 56 | imap.pass:: |
c82b0748 RS |
57 | The password to use when logging in to the server. |
58 | ||
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. | |
63 | ||
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. | |
68 | ||
c64d84f1 JW |
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`. | |
75 | ||
ae9c606e HM |
76 | imap.authMethod:: |
77 | Specify authenticate method for authentication with IMAP server. | |
78 | Current supported method is 'CRAM-MD5' only. | |
79 | ||
c82b0748 RS |
80 | Examples |
81 | ~~~~~~~~ | |
82 | ||
83 | Using tunnel mode: | |
454a35b8 | 84 | |
2b5f3ed3 | 85 | .......................... |
454a35b8 | 86 | [imap] |
c82b0748 RS |
87 | folder = "INBOX.Drafts" |
88 | tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null" | |
89 | .......................... | |
454a35b8 | 90 | |
c82b0748 RS |
91 | Using direct mode: |
92 | ||
93 | ......................... | |
454a35b8 | 94 | [imap] |
c82b0748 RS |
95 | folder = "INBOX.Drafts" |
96 | host = imap://imap.example.com | |
97 | user = bob | |
98 | pass = p4ssw0rd | |
99 | .......................... | |
100 | ||
101 | Using direct mode with SSL: | |
454a35b8 | 102 | |
c82b0748 | 103 | ......................... |
454a35b8 | 104 | [imap] |
c82b0748 RS |
105 | folder = "INBOX.Drafts" |
106 | host = imaps://imap.example.com | |
107 | user = bob | |
108 | pass = p4ssw0rd | |
109 | port = 123 | |
684ec6c6 | 110 | sslverify = false |
2b5f3ed3 | 111 | .......................... |
454a35b8 MM |
112 | |
113 | ||
1a526d48 JW |
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. | |
122 | ||
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 | |
126 | ||
454a35b8 MM |
127 | Author |
128 | ------ | |
129 | Derived from isync 1.0.1 by Mike McCormack. | |
130 | ||
131 | Documentation | |
132 | -------------- | |
133 | Documentation by Mike McCormack | |
134 | ||
135 | GIT | |
136 | --- | |
9e1f0a85 | 137 | Part of the linkgit:git[1] suite |