1 /* vi: set sw=4 ts=4: */
3 * popmaildir: a simple yet powerful POP3 client
4 * Delivers contents of remote mailboxes to local Maildir
6 * Inspired by original utility by Nikola Vladov
8 * Copyright (C) 2008 by Vladimir Dronnikov <dronnikov@gmail.com>
10 * Licensed under GPLv2, see file LICENSE in this source tree.
12 //config:config POPMAILDIR
13 //config: bool "popmaildir"
16 //config: Simple yet powerful POP3 mail popper. Delivers content
17 //config: of remote mailboxes to local Maildir.
19 //config:config FEATURE_POPMAILDIR_DELIVERY
20 //config: bool "Allow message filters and custom delivery program"
22 //config: depends on POPMAILDIR
24 //config: Allow to use a custom program to filter the content
25 //config: of the message before actual delivery (-F "prog [args...]").
26 //config: Allow to use a custom program for message actual delivery
27 //config: (-M "prog [args...]").
29 //applet:IF_POPMAILDIR(APPLET(popmaildir, BB_DIR_USR_SBIN, BB_SUID_DROP))
31 //kbuild:lib-$(CONFIG_POPMAILDIR) += popmaildir.o mail.o
33 //usage:#define popmaildir_trivial_usage
34 //usage: "[OPTIONS] MAILDIR [CONN_HELPER ARGS]"
35 //usage:#define popmaildir_full_usage "\n\n"
36 //usage: "Fetch content of remote mailbox to local maildir\n"
37 /* //usage: "\n -b Binary mode. Ignored" */
38 /* //usage: "\n -d Debug. Ignored" */
39 /* //usage: "\n -m Show used memory. Ignored" */
40 /* //usage: "\n -V Show version. Ignored" */
41 /* //usage: "\n -c Use tcpclient. Ignored" */
42 /* //usage: "\n -a Use APOP protocol. Implied. If server supports APOP -> use it" */
43 //usage: "\n -s Skip authorization"
44 //usage: "\n -T Get messages with TOP instead of RETR"
45 //usage: "\n -k Keep retrieved messages on the server"
46 //usage: "\n -t SEC Network timeout"
47 //usage: IF_FEATURE_POPMAILDIR_DELIVERY(
48 //usage: "\n -F \"PROG ARGS\" Filter program (may be repeated)"
49 //usage: "\n -M \"PROG ARGS\" Delivery program"
52 //usage: "\nFetch from plain POP3 server:"
53 //usage: "\npopmaildir -k DIR nc pop3.server.com 110 <user_and_pass.txt"
54 //usage: "\nFetch from SSLed POP3 server and delete fetched emails:"
55 //usage: "\npopmaildir DIR -- openssl s_client -quiet -connect pop3.server.com:995 <user_and_pass.txt"
56 /* //usage: "\n -R BYTES Remove old messages on the server >= BYTES. Ignored" */
57 /* //usage: "\n -Z N1-N2 Remove messages from N1 to N2 (dangerous). Ignored" */
58 /* //usage: "\n -L BYTES Don't retrieve new messages >= BYTES. Ignored" */
59 /* //usage: "\n -H LINES Type first LINES of a message. Ignored" */
61 //usage:#define popmaildir_example_usage
62 //usage: "$ popmaildir -k ~/Maildir -- nc pop.drvv.ru 110 [<password_file]\n"
63 //usage: "$ popmaildir ~/Maildir -- openssl s_client -quiet -connect pop.gmail.com:995 [<password_file]\n"
68 static void pop3_checkr(const char *fmt, const char *param, char **ret)
70 char *msg = send_mail_command(fmt, param);
71 char *answer = xmalloc_fgetline(stdin);
72 if (answer && '+' == answer[0]) {
78 memmove(answer, answer + 4, strlen(answer) - 4);
84 bb_error_msg_and_die("%s failed, reply was: %s", msg, answer);
87 static void pop3_check(const char *fmt, const char *param)
89 pop3_checkr(fmt, param, NULL);
92 int popmaildir_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
93 int popmaildir_main(int argc UNUSED_PARAM, char **argv)
100 #if ENABLE_FEATURE_POPMAILDIR_DELIVERY
101 const char *delivery;
103 unsigned opt_nlines = 0;
106 OPT_b = 1 << 0, // -b binary mode. Ignored
107 OPT_d = 1 << 1, // -d,-dd,-ddd debug. Ignored
108 OPT_m = 1 << 2, // -m show used memory. Ignored
109 OPT_V = 1 << 3, // -V version. Ignored
110 OPT_c = 1 << 4, // -c use tcpclient. Ignored
111 OPT_a = 1 << 5, // -a use APOP protocol
112 OPT_s = 1 << 6, // -s skip authorization
113 OPT_T = 1 << 7, // -T get messages with TOP instead with RETR
114 OPT_k = 1 << 8, // -k keep retrieved messages on the server
115 OPT_t = 1 << 9, // -t90 set timeout to 90 sec
116 OPT_R = 1 << 10, // -R20000 remove old messages on the server >= 20000 bytes (requires -k). Ignored
117 OPT_Z = 1 << 11, // -Z11-23 remove messages from 11 to 23 (dangerous). Ignored
118 OPT_L = 1 << 12, // -L50000 not retrieve new messages >= 50000 bytes. Ignored
119 OPT_H = 1 << 13, // -H30 type first 30 lines of a message; (-L12000 -H30). Ignored
120 OPT_M = 1 << 14, // -M\"program arg1 arg2 ...\"; deliver by program. Treated like -F
121 OPT_F = 1 << 15, // -F\"program arg1 arg2 ...\"; filter by program. Treated like -M
124 // init global variables
128 opt_complementary = "-1:dd";
129 opts = getopt32(argv,
130 "bdmVcasTkt:+" "R:+Z:L:+H:+" IF_FEATURE_POPMAILDIR_DELIVERY("M:F:"),
131 &timeout, NULL, NULL, NULL, &opt_nlines
132 IF_FEATURE_POPMAILDIR_DELIVERY(, &delivery, &delivery) // we treat -M and -F the same
139 get_cred_or_die(STDIN_FILENO);
144 // launch connect helper, if any
146 launch_helper((const char **)argv);
148 // get server greeting
149 pop3_checkr(NULL, NULL, &buf);
151 // authenticate (if no -s given)
152 if (!(opts & OPT_s)) {
153 // server supports APOP and we want it?
154 if ('<' == buf[0] && (opts & OPT_a)) {
155 union { // save a bit of stack
157 char hex[16 * 2 + 1];
159 uint32_t res[16 / 4];
161 char *s = strchr(buf, '>');
164 // get md5 sum of "<stamp>password" string
166 md5_hash(&md5.ctx, buf, strlen(buf));
167 md5_hash(&md5.ctx, G.pass, strlen(G.pass));
168 md5_end(&md5.ctx, res);
169 *bin2hex(md5.hex, (char*)res, 16) = '\0';
171 s = xasprintf("%s %s", G.user, md5.hex);
172 pop3_check("APOP %s", s);
175 // server ignores APOP -> use simple text authentication
178 pop3_check("USER %s", G.user);
180 pop3_check("PASS %s", G.pass);
184 // get mailbox statistics
185 pop3_checkr("STAT", NULL, &buf);
187 // prepare message filename suffix
188 hostname = safe_gethostname();
191 // get messages counter
192 // NOTE: we don't use xatou(buf) since buf is "nmsg nbytes"
193 // we only need nmsg and atoi is just exactly what we need
194 // if atoi fails to convert buf into number it returns 0
195 // in this case the following loop simply will not be executed
199 // loop through messages
200 retr = (opts & OPT_T) ? xasprintf("TOP %%u %u", opt_nlines) : "RETR %u";
201 for (; nmsg; nmsg--) {
207 #if ENABLE_FEATURE_POPMAILDIR_DELIVERY
210 // generate unique filename
211 filename = xasprintf("tmp/%llu.%u.%s",
212 monotonic_us(), (unsigned)pid, hostname);
214 // retrieve message in ./tmp/ unless filter is specified
215 pop3_check(retr, (const char *)(ptrdiff_t)nmsg);
217 #if ENABLE_FEATURE_POPMAILDIR_DELIVERY
218 // delivery helper ordered? -> setup pipe
219 if (opts & (OPT_F|OPT_M)) {
220 // helper will have $FILENAME set to filename
221 xsetenv("FILENAME", filename);
222 fp = popen(delivery, "w");
223 unsetenv("FILENAME");
225 bb_perror_msg("delivery helper");
230 // create and open file filename
231 fp = xfopen_for_write(filename);
233 // copy stdin to fp (either filename or delivery helper)
234 while ((answer = xmalloc_fgets_str(stdin, "\r\n")) != NULL) {
236 if ('.' == answer[0]) {
237 if ('.' == answer[1])
239 else if ('\r' == answer[1] && '\n' == answer[2] && '\0' == answer[3])
242 //*strchrnul(s, '\r') = '\n';
247 #if ENABLE_FEATURE_POPMAILDIR_DELIVERY
248 // analyse delivery status
249 if (opts & (OPT_F|OPT_M)) {
251 if (99 == rc) // 99 means bail out
253 // if (rc) // !0 means skip to the next message
255 // // 0 means continue
262 // delete message from server
264 pop3_check("DELE %u", (const char*)(ptrdiff_t)nmsg);
266 // atomically move message to ./new/
267 target = xstrdup(filename);
268 strncpy(target, "new", 3);
269 // ... or just stop receiving on failure
270 if (rename_or_warn(filename, target))
274 #if ENABLE_FEATURE_POPMAILDIR_DELIVERY
281 pop3_check("QUIT", NULL);
283 if (ENABLE_FEATURE_CLEAN_UP) {