NeoMutt  2022-04-29-215-gc12b98
Teaching an old dog new tricks
DOXYGEN
pop.c
Go to the documentation of this file.
1
33#include "config.h"
34#include <errno.h>
35#include <limits.h>
36#include <stdbool.h>
37#include <stdio.h>
38#include <stdlib.h>
39#include <string.h>
40#include <unistd.h>
41#include "private.h"
42#include "mutt/lib.h"
43#include "config/lib.h"
44#include "email/lib.h"
45#include "core/lib.h"
46#include "conn/lib.h"
47#include "lib.h"
48#include "bcache/lib.h"
49#include "ncrypt/lib.h"
50#include "progress/lib.h"
51#include "question/lib.h"
52#include "adata.h"
53#include "edata.h"
54#include "hook.h"
55#include "mutt_account.h"
56#include "mutt_header.h"
57#include "mutt_logging.h"
58#include "mutt_socket.h"
59#include "muttlib.h"
60#include "mx.h"
61#ifdef ENABLE_NLS
62#include <libintl.h>
63#endif
64#ifdef USE_HCACHE
65#include "hcache/lib.h"
66#endif
67
68struct BodyCache;
69struct stat;
70
71#define HC_FNAME "neomutt" /* filename for hcache as POP lacks paths */
72#define HC_FEXT "hcache" /* extension for hcache as POP lacks paths */
73
83static const char *cache_id(const char *id)
84{
85 static char clean[128];
86 mutt_str_copy(clean, id, sizeof(clean));
87 mutt_file_sanitize_filename(clean, true);
88 return clean;
89}
90
98static int fetch_message(const char *line, void *data)
99{
100 FILE *fp = data;
101
102 fputs(line, fp);
103 if (fputc('\n', fp) == EOF)
104 return -1;
105
106 return 0;
107}
108
118static int pop_read_header(struct PopAccountData *adata, struct Email *e)
119{
120 FILE *fp = mutt_file_mkstemp();
121 if (!fp)
122 {
123 mutt_perror(_("Can't create temporary file"));
124 return -3;
125 }
126
127 int index = 0;
128 size_t length = 0;
129 char buf[1024] = { 0 };
130
131 struct PopEmailData *edata = pop_edata_get(e);
132
133 snprintf(buf, sizeof(buf), "LIST %d\r\n", edata->refno);
134 int rc = pop_query(adata, buf, sizeof(buf));
135 if (rc == 0)
136 {
137 sscanf(buf, "+OK %d %zu", &index, &length);
138
139 snprintf(buf, sizeof(buf), "TOP %d 0\r\n", edata->refno);
140 rc = pop_fetch_data(adata, buf, NULL, fetch_message, fp);
141
142 if (adata->cmd_top == 2)
143 {
144 if (rc == 0)
145 {
146 adata->cmd_top = 1;
147
148 mutt_debug(LL_DEBUG1, "set TOP capability\n");
149 }
150
151 if (rc == -2)
152 {
153 adata->cmd_top = 0;
154
155 mutt_debug(LL_DEBUG1, "unset TOP capability\n");
156 snprintf(adata->err_msg, sizeof(adata->err_msg), "%s",
157 _("Command TOP is not supported by server"));
158 }
159 }
160 }
161
162 switch (rc)
163 {
164 case 0:
165 {
166 rewind(fp);
167 e->env = mutt_rfc822_read_header(fp, e, false, false);
168 e->body->length = length - e->body->offset + 1;
169 rewind(fp);
170 while (!feof(fp))
171 {
172 e->body->length--;
173 fgets(buf, sizeof(buf), fp);
174 }
175 break;
176 }
177 case -2:
178 {
179 mutt_error("%s", adata->err_msg);
180 break;
181 }
182 case -3:
183 {
184 mutt_error(_("Can't write header to temporary file"));
185 break;
186 }
187 }
188
189 mutt_file_fclose(&fp);
190 return rc;
191}
192
200static int fetch_uidl(const char *line, void *data)
201{
202 struct Mailbox *m = data;
204 char *endp = NULL;
205
206 errno = 0;
207 int index = strtol(line, &endp, 10);
208 if (errno)
209 return -1;
210 while (*endp == ' ')
211 endp++;
212 line = endp;
213
214 /* uid must be at least be 1 byte */
215 if (strlen(line) == 0)
216 return -1;
217
218 int i;
219 for (i = 0; i < m->msg_count; i++)
220 {
221 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
222 if (mutt_str_equal(line, edata->uid))
223 break;
224 }
225
226 if (i == m->msg_count)
227 {
228 mutt_debug(LL_DEBUG1, "new header %d %s\n", index, line);
229
230 if (i >= m->email_max)
232
233 m->msg_count++;
234 m->emails[i] = email_new();
235
236 m->emails[i]->edata = pop_edata_new(line);
238 }
239 else if (m->emails[i]->index != index - 1)
240 adata->clear_cache = true;
241
242 m->emails[i]->index = index - 1;
243
244 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
245 edata->refno = index;
246
247 return 0;
248}
249
253static int msg_cache_check(const char *id, struct BodyCache *bcache, void *data)
254{
255 struct Mailbox *m = data;
256 if (!m)
257 return -1;
258
260 if (!adata)
261 return -1;
262
263#ifdef USE_HCACHE
264 /* keep hcache file if hcache == bcache */
265 if (strcmp(HC_FNAME "." HC_FEXT, id) == 0)
266 return 0;
267#endif
268
269 for (int i = 0; i < m->msg_count; i++)
270 {
271 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
272 /* if the id we get is known for a header: done (i.e. keep in cache) */
273 if (edata->uid && mutt_str_equal(edata->uid, id))
274 return 0;
275 }
276
277 /* message not found in context -> remove it from cache
278 * return the result of bcache, so we stop upon its first error */
279 return mutt_bcache_del(bcache, cache_id(id));
280}
281
282#ifdef USE_HCACHE
286static void pop_hcache_namer(const char *path, struct Buffer *dest)
287{
288 mutt_buffer_printf(dest, "%s." HC_FEXT, path);
289}
290
297static struct HeaderCache *pop_hcache_open(struct PopAccountData *adata, const char *path)
298{
299 const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
300 if (!adata || !adata->conn)
301 return mutt_hcache_open(c_header_cache, path, NULL);
302
303 struct Url url = { 0 };
304 char p[1024] = { 0 };
305
306 mutt_account_tourl(&adata->conn->account, &url);
307 url.path = HC_FNAME;
308 url_tostring(&url, p, sizeof(p), U_PATH);
309 return mutt_hcache_open(c_header_cache, p, pop_hcache_namer);
310}
311#endif
312
321static int pop_fetch_headers(struct Mailbox *m)
322{
323 if (!m)
324 return -1;
325
327 struct Progress *progress = NULL;
328
329#ifdef USE_HCACHE
330 struct HeaderCache *hc = pop_hcache_open(adata, mailbox_path(m));
331#endif
332
333 adata->check_time = mutt_date_epoch();
334 adata->clear_cache = false;
335
336 for (int i = 0; i < m->msg_count; i++)
337 {
338 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
339 edata->refno = -1;
340 }
341
342 const int old_count = m->msg_count;
343 int rc = pop_fetch_data(adata, "UIDL\r\n", NULL, fetch_uidl, m);
344 const int new_count = m->msg_count;
345 m->msg_count = old_count;
346
347 if (adata->cmd_uidl == 2)
348 {
349 if (rc == 0)
350 {
351 adata->cmd_uidl = 1;
352
353 mutt_debug(LL_DEBUG1, "set UIDL capability\n");
354 }
355
356 if ((rc == -2) && (adata->cmd_uidl == 2))
357 {
358 adata->cmd_uidl = 0;
359
360 mutt_debug(LL_DEBUG1, "unset UIDL capability\n");
361 snprintf(adata->err_msg, sizeof(adata->err_msg), "%s",
362 _("Command UIDL is not supported by server"));
363 }
364 }
365
366 if (m->verbose)
367 {
368 progress = progress_new(_("Fetching message headers..."),
369 MUTT_PROGRESS_READ, new_count - old_count);
370 }
371
372 if (rc == 0)
373 {
374 int i, deleted;
375 for (i = 0, deleted = 0; i < old_count; i++)
376 {
377 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
378 if (edata->refno == -1)
379 {
380 m->emails[i]->deleted = true;
381 deleted++;
382 }
383 }
384 if (deleted > 0)
385 {
386 mutt_error(ngettext("%d message has been lost. Try reopening the mailbox.",
387 "%d messages have been lost. Try reopening the mailbox.", deleted),
388 deleted);
389 }
390
391 bool hcached = false;
392 for (i = old_count; i < new_count; i++)
393 {
394 if (m->verbose)
395 progress_update(progress, i + 1 - old_count, -1);
396 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
397#ifdef USE_HCACHE
398 struct HCacheEntry hce = mutt_hcache_fetch(hc, edata->uid, strlen(edata->uid), 0);
399 if (hce.email)
400 {
401 /* Detach the private data */
402 m->emails[i]->edata = NULL;
403
404 int index = m->emails[i]->index;
405 /* - POP dynamically numbers headers and relies on e->refno
406 * to map messages; so restore header and overwrite restored
407 * refno with current refno, same for index
408 * - e->data needs to a separate pointer as it's driver-specific
409 * data freed separately elsewhere
410 * (the old e->data should point inside a malloc'd block from
411 * hcache so there shouldn't be a memleak here) */
412 email_free(&m->emails[i]);
413 m->emails[i] = hce.email;
414 m->emails[i]->index = index;
415
416 /* Reattach the private data */
417 m->emails[i]->edata = edata;
419 rc = 0;
420 hcached = true;
421 }
422 else
423#endif
424 if ((rc = pop_read_header(adata, m->emails[i])) < 0)
425 break;
426#ifdef USE_HCACHE
427 else
428 {
429 mutt_hcache_store(hc, edata->uid, strlen(edata->uid), m->emails[i], 0);
430 }
431#endif
432
433 /* faked support for flags works like this:
434 * - if 'hcached' is true, we have the message in our hcache:
435 * - if we also have a body: read
436 * - if we don't have a body: old
437 * (if $mark_old is set which is maybe wrong as
438 * $mark_old should be considered for syncing the
439 * folder and not when opening it XXX)
440 * - if 'hcached' is false, we don't have the message in our hcache:
441 * - if we also have a body: read
442 * - if we don't have a body: new */
443 const bool bcached = (mutt_bcache_exists(adata->bcache, cache_id(edata->uid)) == 0);
444 m->emails[i]->old = false;
445 m->emails[i]->read = false;
446 if (hcached)
447 {
448 const bool c_mark_old = cs_subset_bool(NeoMutt->sub, "mark_old");
449 if (bcached)
450 m->emails[i]->read = true;
451 else if (c_mark_old)
452 m->emails[i]->old = true;
453 }
454 else
455 {
456 if (bcached)
457 m->emails[i]->read = true;
458 }
459
460 m->msg_count++;
461 }
462 }
463 progress_free(&progress);
464
465#ifdef USE_HCACHE
467#endif
468
469 if (rc < 0)
470 {
471 for (int i = m->msg_count; i < new_count; i++)
472 email_free(&m->emails[i]);
473 return rc;
474 }
475
476 /* after putting the result into our structures,
477 * clean up cache, i.e. wipe messages deleted outside
478 * the availability of our cache */
479 const bool c_message_cache_clean = cs_subset_bool(NeoMutt->sub, "message_cache_clean");
480 if (c_message_cache_clean)
482
484 return new_count - old_count;
485}
486
491static void pop_clear_cache(struct PopAccountData *adata)
492{
493 if (!adata->clear_cache)
494 return;
495
496 mutt_debug(LL_DEBUG1, "delete cached messages\n");
497
498 for (int i = 0; i < POP_CACHE_LEN; i++)
499 {
500 if (adata->cache[i].path)
501 {
502 unlink(adata->cache[i].path);
503 FREE(&adata->cache[i].path);
504 }
505 }
506}
507
512{
513 const char *const c_pop_host = cs_subset_string(NeoMutt->sub, "pop_host");
514 if (!c_pop_host)
515 {
516 mutt_error(_("POP host is not defined"));
517 return;
518 }
519
520 char buf[1024] = { 0 };
521 char msgbuf[128] = { 0 };
522 int last = 0, msgs, bytes, rset = 0, rc;
523 struct ConnAccount cac = { { 0 } };
524
525 char *p = mutt_mem_calloc(strlen(c_pop_host) + 7, sizeof(char));
526 char *url = p;
527 if (url_check_scheme(c_pop_host) == U_UNKNOWN)
528 {
529 strcpy(url, "pop://");
530 p = strchr(url, '\0');
531 }
532 strcpy(p, c_pop_host);
533
534 rc = pop_parse_path(url, &cac);
535 FREE(&url);
536 if (rc)
537 {
538 mutt_error(_("%s is an invalid POP path"), c_pop_host);
539 return;
540 }
541
542 struct Connection *conn = mutt_conn_find(&cac);
543 if (!conn)
544 return;
545
547 adata->conn = conn;
548
549 if (pop_open_connection(adata) < 0)
550 {
551 //XXX mutt_socket_free(adata->conn);
552 pop_adata_free((void **) &adata);
553 return;
554 }
555
556 mutt_message(_("Checking for new messages..."));
557
558 /* find out how many messages are in the mailbox. */
559 mutt_str_copy(buf, "STAT\r\n", sizeof(buf));
560 rc = pop_query(adata, buf, sizeof(buf));
561 if (rc == -1)
562 goto fail;
563 if (rc == -2)
564 {
565 mutt_error("%s", adata->err_msg);
566 goto finish;
567 }
568
569 sscanf(buf, "+OK %d %d", &msgs, &bytes);
570
571 /* only get unread messages */
572 const bool c_pop_last = cs_subset_bool(NeoMutt->sub, "pop_last");
573 if ((msgs > 0) && c_pop_last)
574 {
575 mutt_str_copy(buf, "LAST\r\n", sizeof(buf));
576 rc = pop_query(adata, buf, sizeof(buf));
577 if (rc == -1)
578 goto fail;
579 if (rc == 0)
580 sscanf(buf, "+OK %d", &last);
581 }
582
583 if (msgs <= last)
584 {
585 mutt_message(_("No new mail in POP mailbox"));
586 goto finish;
587 }
588
589 const char *const c_spool_file = cs_subset_string(NeoMutt->sub, "spool_file");
590 struct Mailbox *m_spool = mx_path_resolve(c_spool_file);
591
592 if (!mx_mbox_open(m_spool, MUTT_OPEN_NO_FLAGS))
593 {
594 mailbox_free(&m_spool);
595 goto finish;
596 }
597 bool old_append = m_spool->append;
598 m_spool->append = true;
599
600 const enum QuadOption c_pop_delete = cs_subset_quad(NeoMutt->sub, "pop_delete");
601 enum QuadOption delanswer = query_quadoption(c_pop_delete, _("Delete messages from server?"));
602
603 snprintf(msgbuf, sizeof(msgbuf),
604 ngettext("Reading new messages (%d byte)...",
605 "Reading new messages (%d bytes)...", bytes),
606 bytes);
607 mutt_message("%s", msgbuf);
608
609 for (int i = last + 1; i <= msgs; i++)
610 {
611 struct Message *msg = mx_msg_open_new(m_spool, NULL, MUTT_ADD_FROM);
612 if (msg)
613 {
614 snprintf(buf, sizeof(buf), "RETR %d\r\n", i);
615 rc = pop_fetch_data(adata, buf, NULL, fetch_message, msg->fp);
616 if (rc == -3)
617 rset = 1;
618
619 if ((rc == 0) && (mx_msg_commit(m_spool, msg) != 0))
620 {
621 rset = 1;
622 rc = -3;
623 }
624
625 mx_msg_close(m_spool, &msg);
626 }
627 else
628 {
629 rc = -3;
630 }
631
632 if ((rc == 0) && (delanswer == MUTT_YES))
633 {
634 /* delete the message on the server */
635 snprintf(buf, sizeof(buf), "DELE %d\r\n", i);
636 rc = pop_query(adata, buf, sizeof(buf));
637 }
638
639 if (rc == -1)
640 {
641 m_spool->append = old_append;
642 mx_mbox_close(m_spool);
643 goto fail;
644 }
645 if (rc == -2)
646 {
647 mutt_error("%s", adata->err_msg);
648 break;
649 }
650 if (rc == -3)
651 {
652 mutt_error(_("Error while writing mailbox"));
653 break;
654 }
655
656 /* L10N: The plural is picked by the second numerical argument, i.e.
657 the %d right before 'messages', i.e. the total number of messages. */
658 mutt_message(ngettext("%s [%d of %d message read]",
659 "%s [%d of %d messages read]", msgs - last),
660 msgbuf, i - last, msgs - last);
661 }
662
663 m_spool->append = old_append;
664 mx_mbox_close(m_spool);
665
666 if (rset)
667 {
668 /* make sure no messages get deleted */
669 mutt_str_copy(buf, "RSET\r\n", sizeof(buf));
670 if (pop_query(adata, buf, sizeof(buf)) == -1)
671 goto fail;
672 }
673
674finish:
675 /* exit gracefully */
676 mutt_str_copy(buf, "QUIT\r\n", sizeof(buf));
677 if (pop_query(adata, buf, sizeof(buf)) == -1)
678 goto fail;
679 mutt_socket_close(conn);
680 FREE(&conn);
681 pop_adata_free((void **) &adata);
682 return;
683
684fail:
685 mutt_error(_("Server closed connection"));
686 mutt_socket_close(conn);
687 pop_adata_free((void **) &adata);
688}
689
693static bool pop_ac_owns_path(struct Account *a, const char *path)
694{
695 struct Url *url = url_parse(path);
696 if (!url)
697 return false;
698
699 struct PopAccountData *adata = a->adata;
700 struct ConnAccount *cac = &adata->conn->account;
701
702 const bool rc = mutt_istr_equal(url->host, cac->host) &&
703 mutt_istr_equal(url->user, cac->user);
704 url_free(&url);
705 return rc;
706}
707
711static bool pop_ac_add(struct Account *a, struct Mailbox *m)
712{
713 if (a->adata)
714 return true;
715
716 struct ConnAccount cac = { { 0 } };
718 a->adata = adata;
720
721 if (pop_parse_path(mailbox_path(m), &cac))
722 {
723 mutt_error(_("%s is an invalid POP path"), mailbox_path(m));
724 return false;
725 }
726
727 adata->conn = mutt_conn_new(&cac);
728 if (!adata->conn)
729 {
730 pop_adata_free((void **) &adata);
731 return false;
732 }
733
734 return true;
735}
736
742static enum MxOpenReturns pop_mbox_open(struct Mailbox *m)
743{
744 if (!m->account)
745 return MX_OPEN_ERROR;
746
747 char buf[PATH_MAX] = { 0 };
748 struct ConnAccount cac = { { 0 } };
749 struct Url url = { 0 };
750
751 if (pop_parse_path(mailbox_path(m), &cac))
752 {
753 mutt_error(_("%s is an invalid POP path"), mailbox_path(m));
754 return MX_OPEN_ERROR;
755 }
756
757 mutt_account_tourl(&cac, &url);
758 url.path = NULL;
759 url_tostring(&url, buf, sizeof(buf), U_NO_FLAGS);
760
761 mutt_buffer_strcpy(&m->pathbuf, buf);
763
764 struct PopAccountData *adata = m->account->adata;
765 if (!adata)
766 {
768 m->account->adata = adata;
770 }
771
772 struct Connection *conn = adata->conn;
773 if (!conn)
774 {
775 adata->conn = mutt_conn_new(&cac);
776 conn = adata->conn;
777 if (!conn)
778 return MX_OPEN_ERROR;
779 }
780
781 if (conn->fd < 0)
783
784 if (pop_open_connection(adata) < 0)
785 return MX_OPEN_ERROR;
786
787 adata->bcache = mutt_bcache_open(&cac, NULL);
788
789 /* init (hard-coded) ACL rights */
791#ifdef USE_HCACHE
792 /* flags are managed using header cache, so it only makes sense to
793 * enable them in that case */
795#endif
796
797 while (true)
798 {
799 if (pop_reconnect(m) < 0)
800 return MX_OPEN_ERROR;
801
802 m->size = adata->size;
803
804 mutt_message(_("Fetching list of messages..."));
805
806 const int rc = pop_fetch_headers(m);
807
808 if (rc >= 0)
809 return MX_OPEN_OK;
810
811 if (rc < -1)
812 return MX_OPEN_ERROR;
813 }
814}
815
819static enum MxStatus pop_mbox_check(struct Mailbox *m)
820{
822
823 const short c_pop_check_interval = cs_subset_number(NeoMutt->sub, "pop_check_interval");
824 if ((adata->check_time + c_pop_check_interval) > mutt_date_epoch())
825 return MX_STATUS_OK;
826
827 pop_logout(m);
828
830
831 if (pop_open_connection(adata) < 0)
832 return MX_STATUS_ERROR;
833
834 m->size = adata->size;
835
836 mutt_message(_("Checking for new messages..."));
837
838 int old_msg_count = m->msg_count;
839 int rc = pop_fetch_headers(m);
841 if (m->msg_count > old_msg_count)
843
844 if (rc < 0)
845 return MX_STATUS_ERROR;
846
847 if (rc > 0)
848 return MX_STATUS_NEW_MAIL;
849
850 return MX_STATUS_OK;
851}
852
858static enum MxStatus pop_mbox_sync(struct Mailbox *m)
859{
860 int i, j, rc = 0;
861 char buf[1024] = { 0 };
863#ifdef USE_HCACHE
864 struct HeaderCache *hc = NULL;
865#endif
866
867 adata->check_time = 0;
868
869 int num_deleted = 0;
870 for (i = 0; i < m->msg_count; i++)
871 {
872 if (m->emails[i]->deleted)
873 num_deleted++;
874 }
875
876 while (true)
877 {
878 if (pop_reconnect(m) < 0)
879 return MX_STATUS_ERROR;
880
881#ifdef USE_HCACHE
882 hc = pop_hcache_open(adata, mailbox_path(m));
883#endif
884
885 struct Progress *progress = NULL;
886 if (m->verbose)
887 {
888 progress = progress_new(_("Marking messages deleted..."),
889 MUTT_PROGRESS_WRITE, num_deleted);
890 }
891
892 for (i = 0, j = 0, rc = 0; (rc == 0) && (i < m->msg_count); i++)
893 {
894 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
895 if (m->emails[i]->deleted && (edata->refno != -1))
896 {
897 j++;
898 if (m->verbose)
899 progress_update(progress, j, -1);
900 snprintf(buf, sizeof(buf), "DELE %d\r\n", edata->refno);
901 rc = pop_query(adata, buf, sizeof(buf));
902 if (rc == 0)
903 {
904 mutt_bcache_del(adata->bcache, cache_id(edata->uid));
905#ifdef USE_HCACHE
906 mutt_hcache_delete_record(hc, edata->uid, strlen(edata->uid));
907#endif
908 }
909 }
910
911#ifdef USE_HCACHE
912 if (m->emails[i]->changed)
913 {
914 mutt_hcache_store(hc, edata->uid, strlen(edata->uid), m->emails[i], 0);
915 }
916#endif
917 }
918 progress_free(&progress);
919
920#ifdef USE_HCACHE
922#endif
923
924 if (rc == 0)
925 {
926 mutt_str_copy(buf, "QUIT\r\n", sizeof(buf));
927 rc = pop_query(adata, buf, sizeof(buf));
928 }
929
930 if (rc == 0)
931 {
932 adata->clear_cache = true;
933 pop_clear_cache(adata);
934 adata->status = POP_DISCONNECTED;
935 return MX_STATUS_OK;
936 }
937
938 if (rc == -2)
939 {
940 mutt_error("%s", adata->err_msg);
941 return MX_STATUS_ERROR;
942 }
943 }
944}
945
949static enum MxStatus pop_mbox_close(struct Mailbox *m)
950{
952 if (!adata)
953 return MX_STATUS_OK;
954
955 pop_logout(m);
956
957 if (adata->status != POP_NONE)
958 {
960 // FREE(&adata->conn);
961 }
962
963 adata->status = POP_NONE;
964
965 adata->clear_cache = true;
967
968 mutt_bcache_close(&adata->bcache);
969
970 return MX_STATUS_OK;
971}
972
976static bool pop_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
977{
978 char buf[1024] = { 0 };
980 struct Email *e = m->emails[msgno];
981 struct PopEmailData *edata = pop_edata_get(e);
982 bool bcache = true;
983 bool success = false;
984 struct Buffer *path = NULL;
985
986 /* see if we already have the message in body cache */
987 msg->fp = mutt_bcache_get(adata->bcache, cache_id(edata->uid));
988 if (msg->fp)
989 return true;
990
991 /* see if we already have the message in our cache in
992 * case $message_cachedir is unset */
993 struct PopCache *cache = &adata->cache[e->index % POP_CACHE_LEN];
994
995 if (cache->path)
996 {
997 if (cache->index == e->index)
998 {
999 /* yes, so just return a pointer to the message */
1000 msg->fp = fopen(cache->path, "r");
1001 if (msg->fp)
1002 return true;
1003
1004 mutt_perror(cache->path);
1005 return false;
1006 }
1007 else
1008 {
1009 /* clear the previous entry */
1010 unlink(cache->path);
1011 FREE(&cache->path);
1012 }
1013 }
1014
1016
1017 while (true)
1018 {
1019 if (pop_reconnect(m) < 0)
1020 goto cleanup;
1021
1022 /* verify that massage index is correct */
1023 if (edata->refno < 0)
1024 {
1025 mutt_error(_("The message index is incorrect. Try reopening the mailbox."));
1026 goto cleanup;
1027 }
1028
1029 /* see if we can put in body cache; use our cache as fallback */
1030 msg->fp = mutt_bcache_put(adata->bcache, cache_id(edata->uid));
1031 if (!msg->fp)
1032 {
1033 /* no */
1034 bcache = false;
1037 if (!msg->fp)
1038 {
1040 goto cleanup;
1041 }
1042 }
1043
1044 snprintf(buf, sizeof(buf), "RETR %d\r\n", edata->refno);
1045
1046 struct Progress *progress = progress_new(_("Fetching message..."), MUTT_PROGRESS_NET,
1047 e->body->length + e->body->offset - 1);
1048 const int rc = pop_fetch_data(adata, buf, progress, fetch_message, msg->fp);
1049 progress_free(&progress);
1050
1051 if (rc == 0)
1052 break;
1053
1054 mutt_file_fclose(&msg->fp);
1055
1056 /* if RETR failed (e.g. connection closed), be sure to remove either
1057 * the file in bcache or from POP's own cache since the next iteration
1058 * of the loop will re-attempt to put() the message */
1059 if (!bcache)
1060 unlink(mutt_buffer_string(path));
1061
1062 if (rc == -2)
1063 {
1064 mutt_error("%s", adata->err_msg);
1065 goto cleanup;
1066 }
1067
1068 if (rc == -3)
1069 {
1070 mutt_error(_("Can't write message to temporary file"));
1071 goto cleanup;
1072 }
1073 }
1074
1075 /* Update the header information. Previously, we only downloaded a
1076 * portion of the headers, those required for the main display. */
1077 if (bcache)
1078 mutt_bcache_commit(adata->bcache, cache_id(edata->uid));
1079 else
1080 {
1081 cache->index = e->index;
1082 cache->path = mutt_buffer_strdup(path);
1083 }
1084 rewind(msg->fp);
1085
1086 /* Detach the private data */
1087 e->edata = NULL;
1088
1089 /* we replace envelope, key in subj_hash has to be updated as well */
1090 if (m->subj_hash && e->env->real_subj)
1093 mutt_env_free(&e->env);
1094 e->env = mutt_rfc822_read_header(msg->fp, e, false, false);
1095 if (m->subj_hash && e->env->real_subj)
1097 mutt_label_hash_add(m, e);
1098
1099 /* Reattach the private data */
1100 e->edata = edata;
1102
1103 e->lines = 0;
1104 fgets(buf, sizeof(buf), msg->fp);
1105 while (!feof(msg->fp))
1106 {
1107 m->emails[msgno]->lines++;
1108 fgets(buf, sizeof(buf), msg->fp);
1109 }
1110
1111 e->body->length = ftello(msg->fp) - e->body->offset;
1112
1113 /* This needs to be done in case this is a multipart message */
1114 if (!WithCrypto)
1115 e->security = crypt_query(e->body);
1116
1118 rewind(msg->fp);
1119
1120 success = true;
1121
1122cleanup:
1124 return success;
1125}
1126
1132static int pop_msg_close(struct Mailbox *m, struct Message *msg)
1133{
1134 return mutt_file_fclose(&msg->fp);
1135}
1136
1140static int pop_msg_save_hcache(struct Mailbox *m, struct Email *e)
1141{
1142 int rc = 0;
1143#ifdef USE_HCACHE
1144 struct PopAccountData *adata = pop_adata_get(m);
1145 struct PopEmailData *edata = e->edata;
1146 struct HeaderCache *hc = pop_hcache_open(adata, mailbox_path(m));
1147 rc = mutt_hcache_store(hc, edata->uid, strlen(edata->uid), e, 0);
1149#endif
1150
1151 return rc;
1152}
1153
1157enum MailboxType pop_path_probe(const char *path, const struct stat *st)
1158{
1159 if (mutt_istr_startswith(path, "pop://"))
1160 return MUTT_POP;
1161
1162 if (mutt_istr_startswith(path, "pops://"))
1163 return MUTT_POP;
1164
1165 return MUTT_UNKNOWN;
1166}
1167
1171static int pop_path_canon(char *buf, size_t buflen)
1172{
1173 return 0;
1174}
1175
1179static int pop_path_pretty(char *buf, size_t buflen, const char *folder)
1180{
1181 /* Succeed, but don't do anything, for now */
1182 return 0;
1183}
1184
1188static int pop_path_parent(char *buf, size_t buflen)
1189{
1190 /* Succeed, but don't do anything, for now */
1191 return 0;
1192}
1193
1197struct MxOps MxPopOps = {
1198 // clang-format off
1199 .type = MUTT_POP,
1200 .name = "pop",
1201 .is_local = false,
1202 .ac_owns_path = pop_ac_owns_path,
1203 .ac_add = pop_ac_add,
1204 .mbox_open = pop_mbox_open,
1205 .mbox_open_append = NULL,
1206 .mbox_check = pop_mbox_check,
1207 .mbox_check_stats = NULL,
1208 .mbox_sync = pop_mbox_sync,
1209 .mbox_close = pop_mbox_close,
1210 .msg_open = pop_msg_open,
1211 .msg_open_new = NULL,
1212 .msg_commit = NULL,
1213 .msg_close = pop_msg_close,
1214 .msg_padding_size = NULL,
1215 .msg_save_hcache = pop_msg_save_hcache,
1216 .tags_edit = NULL,
1217 .tags_commit = NULL,
1218 .path_probe = pop_path_probe,
1219 .path_canon = pop_path_canon,
1220 .path_pretty = pop_path_pretty,
1221 .path_parent = pop_path_parent,
1222 .path_is_empty = NULL,
1223 // clang-format on
1224};
Body Caching (local copies of email bodies)
int mutt_bcache_exists(struct BodyCache *bcache, const char *id)
Check if a file exists in the Body Cache.
Definition: bcache.c:288
int mutt_bcache_commit(struct BodyCache *bcache, const char *id)
Move a temporary file into the Body Cache.
Definition: bcache.c:248
struct BodyCache * mutt_bcache_open(struct ConnAccount *account, const char *mailbox)
Open an Email-Body Cache.
Definition: bcache.c:144
int mutt_bcache_list(struct BodyCache *bcache, bcache_list_t want_id, void *data)
Find matching entries in the Body Cache.
Definition: bcache.c:330
FILE * mutt_bcache_get(struct BodyCache *bcache, const char *id)
Open a file in the Body Cache.
Definition: bcache.c:180
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition: bcache.c:265
FILE * mutt_bcache_put(struct BodyCache *bcache, const char *id)
Create a file in the Body Cache.
Definition: bcache.c:208
void mutt_bcache_close(struct BodyCache **bcache)
Close an Email-Body Cache.
Definition: bcache.c:165
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:327
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:168
char * mutt_buffer_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:447
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:317
enum QuadOption cs_subset_quad(const struct ConfigSubset *sub, const char *name)
Get a quad-value config item by name.
Definition: helpers.c:218
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:169
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:194
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
Convenience wrapper for the config headers.
Connection Library.
Convenience wrapper for the core headers.
SecurityFlags crypt_query(struct Body *b)
Check out the type of encryption used.
Definition: crypt.c:675
time_t mutt_date_epoch(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:428
struct Email * email_new(void)
Create a new Email.
Definition: email.c:78
void email_free(struct Email **ptr)
Free an Email.
Definition: email.c:44
Structs that make up an email.
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:97
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:618
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
void mutt_file_sanitize_filename(char *path, bool slash)
Replace unsafe characters in a filename.
Definition: file.c:647
#define mutt_file_mkstemp()
Definition: file.h:112
static int msg_cache_check(const char *id, struct BodyCache *bcache, void *data)
Check the Body Cache for an ID - Implements bcache_list_t -.
Definition: pop.c:253
static void pop_hcache_namer(const char *path, struct Buffer *dest)
Create a header cache filename for a POP mailbox - Implements hcache_namer_t -.
Definition: pop.c:286
#define mutt_error(...)
Definition: logging.h:87
#define mutt_message(...)
Definition: logging.h:86
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
#define mutt_perror(...)
Definition: logging.h:88
static bool pop_ac_add(struct Account *a, struct Mailbox *m)
Add a Mailbox to an Account - Implements MxOps::ac_add() -.
Definition: pop.c:711
static bool pop_ac_owns_path(struct Account *a, const char *path)
Check whether an Account owns a Mailbox path - Implements MxOps::ac_owns_path() -.
Definition: pop.c:693
struct MxOps MxPopOps
POP Mailbox - Implements MxOps -.
Definition: pop.c:1197
static enum MxStatus pop_mbox_check(struct Mailbox *m)
Check for new mail - Implements MxOps::mbox_check() -.
Definition: pop.c:819
static enum MxStatus pop_mbox_close(struct Mailbox *m)
Close a Mailbox - Implements MxOps::mbox_close() -.
Definition: pop.c:949
static enum MxOpenReturns pop_mbox_open(struct Mailbox *m)
Open a Mailbox - Implements MxOps::mbox_open() -.
Definition: pop.c:742
static enum MxStatus pop_mbox_sync(struct Mailbox *m)
Save changes to the Mailbox - Implements MxOps::mbox_sync() -.
Definition: pop.c:858
static int pop_msg_close(struct Mailbox *m, struct Message *msg)
Close an email - Implements MxOps::msg_close() -.
Definition: pop.c:1132
static bool pop_msg_open(struct Mailbox *m, struct Message *msg, int msgno)
Open an email message in a Mailbox - Implements MxOps::msg_open() -.
Definition: pop.c:976
static int pop_msg_save_hcache(struct Mailbox *m, struct Email *e)
Save message to the header cache - Implements MxOps::msg_save_hcache() -.
Definition: pop.c:1140
static int pop_path_canon(char *buf, size_t buflen)
Canonicalise a Mailbox path - Implements MxOps::path_canon() -.
Definition: pop.c:1171
static int pop_path_parent(char *buf, size_t buflen)
Find the parent of a Mailbox path - Implements MxOps::path_parent() -.
Definition: pop.c:1188
static int pop_path_pretty(char *buf, size_t buflen, const char *folder)
Abbreviate a Mailbox path - Implements MxOps::path_pretty() -.
Definition: pop.c:1179
enum MailboxType pop_path_probe(const char *path, const struct stat *st)
Is this a POP Mailbox? - Implements MxOps::path_probe() -.
Definition: pop.c:1157
static int fetch_message(const char *line, void *data)
Write line to file - Implements pop_fetch_t -.
Definition: pop.c:98
static int fetch_uidl(const char *line, void *data)
Parse UIDL - Implements pop_fetch_t -.
Definition: pop.c:200
struct HashElem * mutt_hash_insert(struct HashTable *table, const char *strkey, void *data)
Add a new element to the Hash Table (with string keys)
Definition: hash.c:335
void mutt_hash_delete(struct HashTable *table, const char *strkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:427
Header cache multiplexor.
int mutt_hcache_store(struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
Multiplexor for StoreOps::store.
Definition: hcache.c:552
void mutt_hcache_close(struct HeaderCache *hc)
Multiplexor for StoreOps::close.
Definition: hcache.c:432
struct HeaderCache * mutt_hcache_open(const char *path, const char *folder, hcache_namer_t namer)
Multiplexor for StoreOps::open.
Definition: hcache.c:332
int mutt_hcache_delete_record(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:631
struct HCacheEntry mutt_hcache_fetch(struct HeaderCache *hc, const char *key, size_t keylen, uint32_t uidvalidity)
Multiplexor for StoreOps::fetch.
Definition: hcache.c:456
void mutt_account_hook(const char *url)
Perform an account hook.
Definition: hook.c:843
Parse and execute user-defined hooks.
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
void mailbox_free(struct Mailbox **ptr)
Free a Mailbox.
Definition: mailbox.c:87
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition: mailbox.c:222
@ NT_MAILBOX_INVALID
Email list was changed.
Definition: mailbox.h:176
#define MUTT_ACL_DELETE
Delete a message.
Definition: mailbox.h:63
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:210
#define MUTT_ACL_WRITE
Write to a message (for flagging or linking threads)
Definition: mailbox.h:71
MailboxType
Supported mailbox formats.
Definition: mailbox.h:41
@ MUTT_POP
'POP3' Mailbox type
Definition: mailbox.h:52
@ MUTT_UNKNOWN
Mailbox wasn't recognised.
Definition: mailbox.h:44
#define MUTT_ACL_SEEN
Change the 'seen' status of a message.
Definition: mailbox.h:70
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define FREE(x)
Definition: memory.h:43
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:819
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:807
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:652
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:239
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:326
#define PATH_MAX
Definition: mutt.h:40
void mutt_account_tourl(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:79
ConnAccount object used by POP and IMAP.
void mutt_label_hash_remove(struct Mailbox *m, struct Email *e)
Remove a message's labels from the Hash Table.
Definition: mutt_header.c:396
void mutt_label_hash_add(struct Mailbox *m, struct Email *e)
Add a message's labels to the Hash Table.
Definition: mutt_header.c:383
Representation of the email's header.
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:74
NeoMutt Logging.
struct Connection * mutt_conn_new(const struct ConnAccount *cac)
Create a new Connection.
Definition: mutt_socket.c:48
struct Connection * mutt_conn_find(const struct ConnAccount *cac)
Find a connection from a list.
Definition: mutt_socket.c:89
NeoMutt connections.
Some miscellaneous functions.
#define mutt_buffer_mktemp(buf)
Definition: muttlib.h:74
int mx_msg_close(struct Mailbox *m, struct Message **msg)
Close a message.
Definition: mx.c:1193
bool mx_mbox_open(struct Mailbox *m, OpenMailboxFlags flags)
Open a mailbox and parse it.
Definition: mx.c:304
void mx_alloc_memory(struct Mailbox *m)
Create storage for the emails.
Definition: mx.c:1219
struct Message * mx_msg_open_new(struct Mailbox *m, const struct Email *e, MsgOpenFlags flags)
Open a new message.
Definition: mx.c:1057
int mx_msg_commit(struct Mailbox *m, struct Message *msg)
Commit a message to a folder - Wrapper for MxOps::msg_commit()
Definition: mx.c:1172
struct Mailbox * mx_path_resolve(const char *path)
Get a Mailbox for a path.
Definition: mx.c:1677
enum MxStatus mx_mbox_close(struct Mailbox *m)
Save changes and close mailbox.
Definition: mx.c:615
API for mailboxes.
#define MUTT_ADD_FROM
add a From_ line
Definition: mx.h:43
MxOpenReturns
Return values for mbox_open()
Definition: mxapi.h:97
@ MX_OPEN_ERROR
Open failed with an error.
Definition: mxapi.h:99
@ MX_OPEN_OK
Open succeeded.
Definition: mxapi.h:98
#define MUTT_OPEN_NO_FLAGS
No flags are set.
Definition: mxapi.h:61
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_snc(), and mbox_close()
Definition: mxapi.h:84
@ MX_STATUS_ERROR
An error occurred.
Definition: mxapi.h:85
@ MX_STATUS_OK
No changes.
Definition: mxapi.h:86
@ MX_STATUS_NEW_MAIL
New mail received in Mailbox.
Definition: mxapi.h:87
API for encryption/signing of emails.
#define WithCrypto
Definition: lib.h:116
struct Envelope * mutt_rfc822_read_header(FILE *fp, struct Email *e, bool user_hdrs, bool weed)
Parses an RFC822 header.
Definition: parse.c:1158
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
struct PopAccountData * pop_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:64
struct PopAccountData * pop_adata_new(void)
Create a new PopAccountData object.
Definition: adata.c:54
void pop_adata_free(void **ptr)
Free the private Account data - Implements Account::adata_free()
Definition: adata.c:40
Pop-specific Account data.
struct PopEmailData * pop_edata_new(const char *uid)
Create a new PopEmailData for an email.
Definition: edata.c:53
void pop_edata_free(void **ptr)
Free the private Email data - Implements Email::edata_free()
Definition: edata.c:41
struct PopEmailData * pop_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:65
Pop-specific Email data.
int pop_open_connection(struct PopAccountData *adata)
Open connection and authenticate.
Definition: lib.c:308
int pop_parse_path(const char *path, struct ConnAccount *cac)
Parse a POP mailbox name.
Definition: lib.c:82
int pop_fetch_data(struct PopAccountData *adata, const char *query, struct Progress *progress, pop_fetch_t callback, void *data)
Read Headers with callback function.
Definition: lib.c:502
void pop_logout(struct Mailbox *m)
Logout from a POP server.
Definition: lib.c:416
int pop_reconnect(struct Mailbox *m)
Reconnect and verify indexes if connection was lost.
Definition: lib.c:599
#define pop_query(adata, buf, buflen)
Definition: private.h:109
#define POP_CACHE_LEN
Definition: private.h:39
@ POP_DISCONNECTED
Disconnected from server.
Definition: private.h:51
@ POP_NONE
No connected to server.
Definition: private.h:49
static void pop_clear_cache(struct PopAccountData *adata)
Delete all cached messages.
Definition: pop.c:491
#define HC_FNAME
Definition: pop.c:71
static const char * cache_id(const char *id)
Make a message-cache-compatible id.
Definition: pop.c:83
static struct HeaderCache * pop_hcache_open(struct PopAccountData *adata, const char *path)
Open the header cache.
Definition: pop.c:297
#define HC_FEXT
Definition: pop.c:72
static int pop_read_header(struct PopAccountData *adata, struct Email *e)
Read header.
Definition: pop.c:118
void pop_fetch_mail(void)
Fetch messages and save them in $spool_file.
Definition: pop.c:511
static int pop_fetch_headers(struct Mailbox *m)
Read headers.
Definition: pop.c:321
Progress bar.
@ MUTT_PROGRESS_NET
Progress tracks bytes, according to $net_inc
Definition: lib.h:51
@ MUTT_PROGRESS_READ
Progress tracks elements, according to $read_inc
Definition: lib.h:49
@ MUTT_PROGRESS_WRITE
Progress tracks elements, according to $write_inc
Definition: lib.h:50
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:86
bool progress_update(struct Progress *progress, size_t pos, int percent)
Update the state of the progress bar.
Definition: progress.c:73
struct Progress * progress_new(const char *msg, enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:118
QuadOption
Possible values for a quad-option.
Definition: quad.h:36
@ MUTT_YES
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:39
Ask the user a question.
enum QuadOption query_quadoption(enum QuadOption opt, const char *prompt)
Ask the user a quad-question.
Definition: question.c:386
GUI display the mailboxes in a side panel.
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:98
Key value store.
A group of associated Mailboxes.
Definition: account.h:37
void(* adata_free)(void **ptr)
Free the private data attached to the Account.
Definition: account.h:53
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
Local cache of email bodies.
Definition: bcache.c:51
LOFF_T offset
offset where the actual data begins
Definition: body.h:52
LOFF_T length
length (in bytes) of attachment
Definition: body.h:53
String manipulation buffer.
Definition: buffer.h:34
Login details for a remote server.
Definition: connaccount.h:53
char user[128]
Username.
Definition: connaccount.h:56
char host[128]
Server to login to.
Definition: connaccount.h:54
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:50
int fd
Socket file descriptor.
Definition: connection.h:54
The envelope/body of an email.
Definition: email.h:37
bool read
Email is read.
Definition: email.h:48
struct Envelope * env
Envelope information.
Definition: email.h:66
void * edata
Driver-specific data.
Definition: email.h:72
int lines
How many lines in the body of this message?
Definition: email.h:60
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib....
Definition: email.h:41
struct Body * body
List of MIME parts.
Definition: email.h:67
bool old
Email is seen, but unread.
Definition: email.h:47
void(* edata_free)(void **ptr)
Free the private data attached to the Email.
Definition: email.h:87
bool changed
Email has been edited.
Definition: email.h:75
int msgno
Number displayed to the user.
Definition: email.h:111
char * path
Path of Email (for local Mailboxes)
Definition: email.h:68
bool deleted
Email is deleted.
Definition: email.h:76
int index
The absolute (unsorted) message number.
Definition: email.h:110
char * real_subj
Offset of the real subject.
Definition: envelope.h:71
Wrapper for Email retrieved from the header cache.
Definition: lib.h:98
struct Email * email
Retrieved email.
Definition: lib.h:101
Header cache structure.
Definition: lib.h:87
char * folder
Folder name.
Definition: lib.h:88
A mailbox.
Definition: mailbox.h:79
char * realpath
Used for duplicate detection, context comparison, and the sidebar.
Definition: mailbox.h:81
bool append
Mailbox is opened in append mode.
Definition: mailbox.h:109
int msg_count
Total number of messages.
Definition: mailbox.h:88
AclFlags rights
ACL bits, see AclFlags.
Definition: mailbox.h:117
int email_max
Number of pointers in emails.
Definition: mailbox.h:97
struct HashTable * subj_hash
Hash Table by subject.
Definition: mailbox.h:124
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
struct Buffer pathbuf
Path of the Mailbox.
Definition: mailbox.h:80
struct Account * account
Account that owns this Mailbox.
Definition: mailbox.h:127
off_t size
Size of the Mailbox.
Definition: mailbox.h:84
bool verbose
Display status messages?
Definition: mailbox.h:114
A local copy of an email.
Definition: mxapi.h:43
FILE * fp
pointer to the message data
Definition: mxapi.h:44
char * path
path to temp file
Definition: mxapi.h:45
Definition: mxapi.h:112
enum MailboxType type
Mailbox type, e.g. MUTT_IMAP.
Definition: mxapi.h:113
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
POP-specific Account data -.
Definition: adata.h:37
size_t size
Definition: adata.h:50
bool clear_cache
Definition: adata.h:49
time_t check_time
Definition: adata.h:51
unsigned int cmd_top
optional command TOP
Definition: adata.h:46
char err_msg[POP_CMD_RESPONSE]
Definition: adata.h:56
unsigned int status
Definition: adata.h:39
struct Connection * conn
Connection to POP server.
Definition: adata.h:38
struct PopCache cache[POP_CACHE_LEN]
Definition: adata.h:57
struct BodyCache * bcache
body cache
Definition: adata.h:55
unsigned int cmd_uidl
optional command UIDL
Definition: adata.h:45
POP-specific email cache.
Definition: private.h:69
unsigned int index
Definition: private.h:70
char * path
Definition: private.h:71
POP-specific Email data -.
Definition: edata.h:32
int refno
Message number on server.
Definition: edata.h:34
const char * uid
UID of email.
Definition: edata.h:33
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition: url.h:69
char * user
Username.
Definition: url.h:71
char * host
Host.
Definition: url.h:73
char * path
Path.
Definition: url.h:75
struct Url * url_parse(const char *src)
Fill in Url.
Definition: url.c:234
int url_tostring(struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:418
void url_free(struct Url **ptr)
Free the contents of a URL.
Definition: url.c:123
enum UrlScheme url_check_scheme(const char *str)
Check the protocol of a URL.
Definition: url.c:221
#define U_NO_FLAGS
Definition: url.h:49
@ U_UNKNOWN
Url wasn't recognised.
Definition: url.h:35
#define U_PATH
Definition: url.h:50