NeoMutt  2024-02-01-25-ga71e95
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
msg_open()

Open an email message in a Mailbox. More...

+ Collaboration diagram for msg_open():

Functions

static bool comp_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
bool imap_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
bool maildir_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
static bool mbox_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
static bool mh_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
static bool nntp_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
static bool nm_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
static bool pop_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 

Detailed Description

Open an email message in a Mailbox.

Parameters
mMailbox
msgMessage to open
eEmail to open
Return values
trueSuccess
falseError
Precondition
m is not NULL
msg is not NULL
e is not NULL

Function Documentation

◆ comp_msg_open()

static bool comp_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)
static

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 731 of file compress.c.

732{
733 if (!m->compress_info)
734 return false;
735
736 struct CompressInfo *ci = m->compress_info;
737
738 const struct MxOps *ops = ci->child_ops;
739 if (!ops)
740 return false;
741
742 /* Delegate */
743 return ops->msg_open(m, msg, e);
744}
Private data for compress.
Definition: lib.h:46
const struct MxOps * child_ops
callbacks of de-compressed file
Definition: lib.h:51
void * compress_info
Compressed mbox module private data.
Definition: mailbox.h:121
Definition: mxapi.h:91
bool(* msg_open)(struct Mailbox *m, struct Message *msg, struct Email *e)
Definition: mxapi.h:216

◆ imap_msg_open()

bool imap_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 1975 of file message.c.

1976{
1977 struct Envelope *newenv = NULL;
1978 char buf[1024] = { 0 };
1979 char *pc = NULL;
1980 unsigned int bytes;
1981 unsigned int uid;
1982 bool retried = false;
1983 bool read;
1984 int rc;
1985
1986 /* Sam's weird courier server returns an OK response even when FETCH
1987 * fails. Thanks Sam. */
1988 bool fetched = false;
1989
1991
1992 if (!adata || (adata->mailbox != m))
1993 return false;
1994
1995 msg->fp = msg_cache_get(m, e);
1996 if (msg->fp)
1997 {
1998 if (imap_edata_get(e)->parsed)
1999 return true;
2000 goto parsemsg;
2001 }
2002
2003 /* This function is called in a few places after endwin()
2004 * e.g. mutt_pipe_message(). */
2005 bool output_progress = !isendwin() && m->verbose;
2006 if (output_progress)
2007 mutt_message(_("Fetching message..."));
2008
2009 msg->fp = msg_cache_put(m, e);
2010 if (!msg->fp)
2011 {
2012 struct Buffer *path = buf_pool_get();
2013 buf_mktemp(path);
2014 msg->fp = mutt_file_fopen(buf_string(path), "w+");
2015 unlink(buf_string(path));
2016 buf_pool_release(&path);
2017
2018 if (!msg->fp)
2019 return false;
2020 }
2021
2022 /* mark this header as currently inactive so the command handler won't
2023 * also try to update it. HACK until all this code can be moved into the
2024 * command handler */
2025 e->active = false;
2026
2027 const bool c_imap_peek = cs_subset_bool(NeoMutt->sub, "imap_peek");
2028 snprintf(buf, sizeof(buf), "UID FETCH %u %s", imap_edata_get(e)->uid,
2029 ((adata->capabilities & IMAP_CAP_IMAP4REV1) ?
2030 (c_imap_peek ? "BODY.PEEK[]" : "BODY[]") :
2031 "RFC822"));
2032
2033 imap_cmd_start(adata, buf);
2034 do
2035 {
2036 rc = imap_cmd_step(adata);
2037 if (rc != IMAP_RES_CONTINUE)
2038 break;
2039
2040 pc = adata->buf;
2041 pc = imap_next_word(pc);
2042 pc = imap_next_word(pc);
2043
2044 if (mutt_istr_startswith(pc, "FETCH"))
2045 {
2046 while (*pc)
2047 {
2048 pc = imap_next_word(pc);
2049 if (pc[0] == '(')
2050 pc++;
2051 if (mutt_istr_startswith(pc, "UID"))
2052 {
2053 pc = imap_next_word(pc);
2054 if (!mutt_str_atoui(pc, &uid))
2055 goto bail;
2056 if (uid != imap_edata_get(e)->uid)
2057 {
2058 mutt_error(_("The message index is incorrect. Try reopening the mailbox."));
2059 }
2060 }
2061 else if (mutt_istr_startswith(pc, "RFC822") || mutt_istr_startswith(pc, "BODY[]"))
2062 {
2063 pc = imap_next_word(pc);
2064 if (imap_get_literal_count(pc, &bytes) < 0)
2065 {
2066 imap_error("imap_msg_open()", buf);
2067 goto bail;
2068 }
2069
2070 const int res = imap_read_literal(msg->fp, adata, bytes, NULL);
2071 if (res < 0)
2072 {
2073 goto bail;
2074 }
2075 /* pick up trailing line */
2076 rc = imap_cmd_step(adata);
2077 if (rc != IMAP_RES_CONTINUE)
2078 goto bail;
2079 pc = adata->buf;
2080
2081 fetched = true;
2082 }
2083 else if (!e->changed && mutt_istr_startswith(pc, "FLAGS"))
2084 {
2085 /* UW-IMAP will provide a FLAGS update here if the FETCH causes a
2086 * change (eg from \Unseen to \Seen).
2087 * Uncommitted changes in neomutt take precedence. If we decide to
2088 * incrementally update flags later, this won't stop us syncing */
2089 pc = imap_set_flags(m, e, pc, NULL);
2090 if (!pc)
2091 goto bail;
2092 }
2093 }
2094 }
2095 } while (rc == IMAP_RES_CONTINUE);
2096
2097 /* see comment before command start. */
2098 e->active = true;
2099
2100 fflush(msg->fp);
2101 if (ferror(msg->fp))
2102 goto bail;
2103
2104 if (rc != IMAP_RES_OK)
2105 goto bail;
2106
2107 if (!fetched || !imap_code(adata->buf))
2108 goto bail;
2109
2110 if (msg_cache_commit(m, e) < 0)
2111 mutt_debug(LL_DEBUG1, "failed to add message to cache\n");
2112
2113parsemsg:
2114 /* Update the header information. Previously, we only downloaded a
2115 * portion of the headers, those required for the main display. */
2116 rewind(msg->fp);
2117 /* It may be that the Status header indicates a message is read, but the
2118 * IMAP server doesn't know the message has been \Seen. So we capture
2119 * the server's notion of 'read' and if it differs from the message info
2120 * picked up in mutt_rfc822_read_header, we mark the message (and context
2121 * changed). Another possibility: ignore Status on IMAP? */
2122 read = e->read;
2123 newenv = mutt_rfc822_read_header(msg->fp, e, false, false);
2124 mutt_env_merge(e->env, &newenv);
2125
2126 /* see above. We want the new status in e->read, so we unset it manually
2127 * and let mutt_set_flag set it correctly, updating context. */
2128 if (read != e->read)
2129 {
2130 e->read = read;
2131 mutt_set_flag(m, e, MUTT_NEW, read, true);
2132 }
2133
2134 e->lines = 0;
2135 while (fgets(buf, sizeof(buf), msg->fp) && !feof(msg->fp))
2136 {
2137 e->lines++;
2138 }
2139
2140 e->body->length = ftell(msg->fp) - e->body->offset;
2141
2143 rewind(msg->fp);
2144 imap_edata_get(e)->parsed = true;
2145
2146 /* retry message parse if cached message is empty */
2147 if (!retried && ((e->lines == 0) || (e->body->length == 0)))
2148 {
2149 imap_cache_del(m, e);
2150 retried = true;
2151 goto parsemsg;
2152 }
2153
2154 return true;
2155
2156bail:
2157 e->active = true;
2158 mutt_file_fclose(&msg->fp);
2159 imap_cache_del(m, e);
2160 return false;
2161}
const char * mutt_str_atoui(const char *str, unsigned int *dst)
Convert ASCII string to an unsigned integer.
Definition: atoi.c:214
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:97
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
struct Envelope * mutt_rfc822_read_header(FILE *fp, struct Email *e, bool user_hdrs, bool weed)
Parses an RFC822 header.
Definition: parse.c:1161
void mutt_env_merge(struct Envelope *base, struct Envelope **extra)
Merge the headers of two Envelopes.
Definition: envelope.c:193
#define mutt_file_fclose(FP)
Definition: file.h:148
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:147
void mutt_set_flag(struct Mailbox *m, struct Email *e, enum MessageType flag, bool bf, bool upd_mbox)
Set a flag on an email.
Definition: flags.c:57
#define mutt_error(...)
Definition: logging2.h:92
#define mutt_message(...)
Definition: logging2.h:91
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:123
int imap_cmd_start(struct ImapAccountData *adata, const char *cmdstr)
Given an IMAP command, send it to the server.
Definition: command.c:1118
int imap_cmd_step(struct ImapAccountData *adata)
Reads server responses from an IMAP command.
Definition: command.c:1132
bool imap_code(const char *s)
Was the command successful.
Definition: command.c:1259
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:67
static FILE * msg_cache_put(struct Mailbox *m, struct Email *e)
Put an email into the message cache.
Definition: message.c:130
char * imap_set_flags(struct Mailbox *m, struct Email *e, char *s, bool *server_changes)
Fill the message header according to the server flags.
Definition: message.c:1918
static FILE * msg_cache_get(struct Mailbox *m, struct Email *e)
Get the message cache entry for an email.
Definition: message.c:109
int imap_cache_del(struct Mailbox *m, struct Email *e)
Delete an email from the body cache.
Definition: message.c:1867
static int msg_cache_commit(struct Mailbox *m, struct Email *e)
Add to the message cache.
Definition: message.c:151
int imap_get_literal_count(const char *buf, unsigned int *bytes)
Write number of bytes in an IMAP literal into bytes.
Definition: util.c:741
#define IMAP_RES_OK
<tag> OK ...
Definition: private.h:55
#define IMAP_CAP_IMAP4REV1
Server supports IMAP4rev1.
Definition: private.h:122
void imap_error(const char *where, const char *msg)
Show an error and abort.
Definition: util.c:657
#define IMAP_RES_CONTINUE
* ...
Definition: private.h:56
char * imap_next_word(char *s)
Find where the next IMAP word begins.
Definition: util.c:785
int imap_read_literal(FILE *fp, struct ImapAccountData *adata, unsigned long bytes, struct Progress *progress)
Read bytes bytes from server into file.
Definition: imap.c:591
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
#define _(a)
Definition: message.h:28
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:242
@ MUTT_NEW
New messages.
Definition: mutt.h:70
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:74
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
void * adata
Private data (for Mailbox backends)
Definition: account.h:42
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:36
bool read
Email is read.
Definition: email.h:50
struct Envelope * env
Envelope information.
Definition: email.h:68
int lines
How many lines in the body of this message?
Definition: email.h:62
struct Body * body
List of MIME parts.
Definition: email.h:69
bool active
Message is not to be removed.
Definition: email.h:76
bool changed
Email has been edited.
Definition: email.h:77
The header of an Email.
Definition: envelope.h:57
IMAP-specific Account data -.
Definition: adata.h:40
ImapCapFlags capabilities
Capability flags.
Definition: adata.h:55
char * buf
Definition: adata.h:59
bool parsed
Definition: edata.h:43
bool verbose
Display status messages?
Definition: mailbox.h:117
FILE * fp
pointer to the message data
Definition: message.h:35
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
#define buf_mktemp(buf)
Definition: tmp.h:33
+ Here is the call graph for this function:

◆ maildir_msg_open()

bool maildir_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 504 of file message.c.

505{
506 char path[PATH_MAX] = { 0 };
507
508 snprintf(path, sizeof(path), "%s/%s", mailbox_path(m), e->path);
509
510 msg->fp = mutt_file_fopen(path, "r");
511 if (!msg->fp && (errno == ENOENT))
512 msg->fp = maildir_open_find_message(mailbox_path(m), e->path, NULL);
513
514 if (!msg->fp)
515 {
516 mutt_perror("%s", path);
517 return false;
518 }
519
520 return true;
521}
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:211
#define mutt_perror(...)
Definition: logging2.h:93
FILE * maildir_open_find_message(const char *folder, const char *msg, char **newname)
Find a message by name.
Definition: message.c:169
#define PATH_MAX
Definition: mutt.h:42
char * path
Path of Email (for local Mailboxes)
Definition: email.h:70
+ Here is the call graph for this function:

◆ mbox_msg_open()

static bool mbox_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)
static

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 1478 of file mbox.c.

1479{
1481 if (!adata)
1482 return false;
1483
1484 msg->fp = mutt_file_fopen(mailbox_path(m), "r");
1485 if (!msg->fp)
1486 return false;
1487
1488 return true;
1489}
static struct MboxAccountData * mbox_adata_get(struct Mailbox *m)
Get the private data associated with a Mailbox.
Definition: mbox.c:123
Mbox-specific Account data -.
Definition: lib.h:49
+ Here is the call graph for this function:

◆ mh_msg_open()

static bool mh_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)
static

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 1141 of file mh.c.

1142{
1143 char path[PATH_MAX] = { 0 };
1144
1145 snprintf(path, sizeof(path), "%s/%s", mailbox_path(m), e->path);
1146
1147 msg->fp = mutt_file_fopen(path, "r");
1148 if (!msg->fp)
1149 {
1150 mutt_perror("%s", path);
1151 return false;
1152 }
1153
1154 return true;
1155}
+ Here is the call graph for this function:

◆ nntp_msg_open()

static bool nntp_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)
static

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 2598 of file nntp.c.

2599{
2600 struct NntpMboxData *mdata = m->mdata;
2601 char article[16] = { 0 };
2602
2603 /* try to get article from cache */
2604 struct NntpAcache *acache = &mdata->acache[e->index % NNTP_ACACHE_LEN];
2605 if (acache->path)
2606 {
2607 if (acache->index == e->index)
2608 {
2609 msg->fp = mutt_file_fopen(acache->path, "r");
2610 if (msg->fp)
2611 return true;
2612 }
2613 else
2614 {
2615 /* clear previous entry */
2616 unlink(acache->path);
2617 FREE(&acache->path);
2618 }
2619 }
2620 snprintf(article, sizeof(article), ANUM_FMT, nntp_edata_get(e)->article_num);
2621 msg->fp = mutt_bcache_get(mdata->bcache, article);
2622 if (msg->fp)
2623 {
2624 if (nntp_edata_get(e)->parsed)
2625 return true;
2626 }
2627 else
2628 {
2629 /* don't try to fetch article from removed newsgroup */
2630 if (mdata->deleted)
2631 return false;
2632
2633 /* create new cache file */
2634 const char *fetch_msg = _("Fetching message...");
2635 mutt_message("%s", fetch_msg);
2636 msg->fp = mutt_bcache_put(mdata->bcache, article);
2637 if (!msg->fp)
2638 {
2639 struct Buffer *tempfile = buf_pool_get();
2640 buf_mktemp(tempfile);
2641 acache->path = buf_strdup(tempfile);
2642 buf_pool_release(&tempfile);
2643 acache->index = e->index;
2644 msg->fp = mutt_file_fopen(acache->path, "w+");
2645 if (!msg->fp)
2646 {
2647 mutt_perror("%s", acache->path);
2648 unlink(acache->path);
2649 FREE(&acache->path);
2650 return false;
2651 }
2652 }
2653
2654 /* fetch message to cache file */
2655 char buf[2048] = { 0 };
2656 snprintf(buf, sizeof(buf), "ARTICLE %s\r\n",
2657 nntp_edata_get(e)->article_num ? article : e->env->message_id);
2658 const int rc = nntp_fetch_lines(mdata, buf, sizeof(buf), NULL, fetch_tempfile, msg->fp);
2659 if (rc)
2660 {
2661 mutt_file_fclose(&msg->fp);
2662 if (acache->path)
2663 {
2664 unlink(acache->path);
2665 FREE(&acache->path);
2666 }
2667 if (rc > 0)
2668 {
2669 if (mutt_str_startswith(buf, nntp_edata_get(e)->article_num ? "423" : "430"))
2670 {
2671 mutt_error(_("Article %s not found on the server"),
2672 nntp_edata_get(e)->article_num ? article : e->env->message_id);
2673 }
2674 else
2675 {
2676 mutt_error("ARTICLE: %s", buf);
2677 }
2678 }
2679 return false;
2680 }
2681
2682 if (!acache->path)
2683 mutt_bcache_commit(mdata->bcache, article);
2684 }
2685
2686 /* replace envelope with new one
2687 * hash elements must be updated because pointers will be changed */
2688 if (m->id_hash && e->env->message_id)
2690 if (m->subj_hash && e->env->real_subj)
2692
2693 mutt_env_free(&e->env);
2694 e->env = mutt_rfc822_read_header(msg->fp, e, false, false);
2695
2696 if (m->id_hash && e->env->message_id)
2698 if (m->subj_hash && e->env->real_subj)
2700
2701 /* fix content length */
2702 if (!mutt_file_seek(msg->fp, 0, SEEK_END))
2703 {
2704 return false;
2705 }
2706 e->body->length = ftell(msg->fp) - e->body->offset;
2707
2708 /* this is called in neomutt before the open which fetches the message,
2709 * which is probably wrong, but we just call it again here to handle
2710 * the problem instead of fixing it */
2711 nntp_edata_get(e)->parsed = true;
2712 mutt_parse_mime_message(e, msg->fp);
2713
2714 /* these would normally be updated in mview_update(), but the
2715 * full headers aren't parsed with overview, so the information wasn't
2716 * available then */
2717 if (WithCrypto)
2718 e->security = crypt_query(e->body);
2719
2720 rewind(msg->fp);
2722 return true;
2723}
void mutt_parse_mime_message(struct Email *e, FILE *fp)
Parse a MIME email.
Definition: attachments.c:597
int mutt_bcache_commit(struct BodyCache *bcache, const char *id)
Move a temporary file into the Body Cache.
Definition: bcache.c:249
FILE * mutt_bcache_get(struct BodyCache *bcache, const char *id)
Open a file in the Body Cache.
Definition: bcache.c:182
FILE * mutt_bcache_put(struct BodyCache *bcache, const char *id)
Create a file in the Body Cache.
Definition: bcache.c:209
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:588
SecurityFlags crypt_query(struct Body *b)
Check out the type of encryption used.
Definition: crypt.c:673
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:126
bool mutt_file_seek(FILE *fp, LOFF_T offset, int whence)
Wrapper for fseeko with error handling.
Definition: file.c:771
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
#define FREE(x)
Definition: memory.h:45
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:230
#define WithCrypto
Definition: lib.h:116
struct NntpEmailData * nntp_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:60
#define NNTP_ACACHE_LEN
Definition: lib.h:81
#define ANUM_FMT
Definition: lib.h:60
static int nntp_fetch_lines(struct NntpMboxData *mdata, char *query, size_t qlen, const char *msg, int(*func)(char *, void *), void *data)
Read lines, calling a callback function for each.
Definition: nntp.c:782
static int fetch_tempfile(char *line, void *data)
Write line to temporary file.
Definition: nntp.c:977
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib....
Definition: email.h:43
int index
The absolute (unsorted) message number.
Definition: email.h:113
char * message_id
Message ID.
Definition: envelope.h:73
char *const real_subj
Offset of the real subject.
Definition: envelope.h:71
void * mdata
Driver specific data.
Definition: mailbox.h:132
struct HashTable * subj_hash
Hash Table: "subject" -> Email.
Definition: mailbox.h:124
struct HashTable * id_hash
Hash Table: "message-id" -> Email.
Definition: mailbox.h:123
NNTP article cache.
Definition: lib.h:66
char * path
Cache path.
Definition: lib.h:68
unsigned int index
Index number.
Definition: lib.h:67
bool parsed
Email has been parse.
Definition: edata.h:37
NNTP-specific Mailbox data -.
Definition: mdata.h:34
bool deleted
Definition: mdata.h:45
struct BodyCache * bcache
Definition: mdata.h:50
struct NntpAcache acache[NNTP_ACACHE_LEN]
Definition: mdata.h:49
+ Here is the call graph for this function:

◆ nm_msg_open()

static bool nm_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)
static

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 2360 of file notmuch.c.

2361{
2362 char path[PATH_MAX] = { 0 };
2363 char *folder = nm_email_get_folder(e);
2364
2365 snprintf(path, sizeof(path), "%s/%s", folder, e->path);
2366
2367 msg->fp = mutt_file_fopen(path, "r");
2368 if (!msg->fp && (errno == ENOENT) && ((m->type == MUTT_MAILDIR) || (m->type == MUTT_NOTMUCH)))
2369 {
2370 msg->fp = maildir_open_find_message(folder, e->path, NULL);
2371 }
2372
2373 return msg->fp != NULL;
2374}
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition: mailbox.h:51
@ MUTT_MAILDIR
'Maildir' Mailbox type
Definition: mailbox.h:48
char * nm_email_get_folder(struct Email *e)
Get the folder for a Email.
Definition: notmuch.c:1469
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
+ Here is the call graph for this function:

◆ pop_msg_open()

static bool pop_msg_open ( struct Mailbox m,
struct Message msg,
struct Email e 
)
static

Open an email message in a Mailbox - Implements MxOps::msg_open() -.

Definition at line 976 of file pop.c.

977{
978 char buf[1024] = { 0 };
980 struct PopEmailData *edata = pop_edata_get(e);
981 bool bcache = true;
982 bool success = false;
983 struct Buffer *path = NULL;
984
985 /* see if we already have the message in body cache */
986 msg->fp = mutt_bcache_get(adata->bcache, cache_id(edata->uid));
987 if (msg->fp)
988 return true;
989
990 /* see if we already have the message in our cache in
991 * case $message_cache_dir is unset */
992 struct PopCache *cache = &adata->cache[e->index % POP_CACHE_LEN];
993
994 if (cache->path)
995 {
996 if (cache->index == e->index)
997 {
998 /* yes, so just return a pointer to the message */
999 msg->fp = mutt_file_fopen(cache->path, "r");
1000 if (msg->fp)
1001 return true;
1002
1003 mutt_perror("%s", cache->path);
1004 return false;
1005 }
1006 else
1007 {
1008 /* clear the previous entry */
1009 unlink(cache->path);
1010 FREE(&cache->path);
1011 }
1012 }
1013
1014 path = buf_pool_get();
1015
1016 while (true)
1017 {
1018 if (pop_reconnect(m) < 0)
1019 goto cleanup;
1020
1021 /* verify that massage index is correct */
1022 if (edata->refno < 0)
1023 {
1024 mutt_error(_("The message index is incorrect. Try reopening the mailbox."));
1025 goto cleanup;
1026 }
1027
1028 /* see if we can put in body cache; use our cache as fallback */
1029 msg->fp = mutt_bcache_put(adata->bcache, cache_id(edata->uid));
1030 if (!msg->fp)
1031 {
1032 /* no */
1033 bcache = false;
1035 msg->fp = mutt_file_fopen(buf_string(path), "w+");
1036 if (!msg->fp)
1037 {
1038 mutt_perror("%s", buf_string(path));
1039 goto cleanup;
1040 }
1041 }
1042
1043 snprintf(buf, sizeof(buf), "RETR %d\r\n", edata->refno);
1044
1045 struct Progress *progress = progress_new(MUTT_PROGRESS_NET,
1046 e->body->length + e->body->offset - 1);
1047 progress_set_message(progress, _("Fetching message..."));
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(buf_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 {
1079 mutt_bcache_commit(adata->bcache, cache_id(edata->uid));
1080 }
1081 else
1082 {
1083 cache->index = e->index;
1084 cache->path = buf_strdup(path);
1085 }
1086 rewind(msg->fp);
1087
1088 /* Detach the private data */
1089 e->edata = NULL;
1090
1091 /* we replace envelope, key in subj_hash has to be updated as well */
1092 if (m->subj_hash && e->env->real_subj)
1095 mutt_env_free(&e->env);
1096 e->env = mutt_rfc822_read_header(msg->fp, e, false, false);
1097 if (m->subj_hash && e->env->real_subj)
1099 mutt_label_hash_add(m, e);
1100
1101 /* Reattach the private data */
1102 e->edata = edata;
1104
1105 e->lines = 0;
1106 while (fgets(buf, sizeof(buf), msg->fp) && !feof(msg->fp))
1107 {
1108 e->lines++;
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:
1123 buf_pool_release(&path);
1124 return success;
1125}
void pop_edata_free(void **ptr)
Free the private Email data - Implements Email::edata_free() -.
Definition: edata.c:41
static int fetch_message(const char *line, void *data)
Parse a Message response - Implements pop_fetch_t -.
Definition: pop.c:99
void mutt_label_hash_remove(struct Mailbox *m, struct Email *e)
Remove a message's labels from the Hash Table.
Definition: mutt_header.c:444
void mutt_label_hash_add(struct Mailbox *m, struct Email *e)
Add a message's labels to the Hash Table.
Definition: mutt_header.c:431
struct PopAccountData * pop_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:73
struct PopEmailData * pop_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:68
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:511
int pop_reconnect(struct Mailbox *m)
Reconnect and verify indexes if connection was lost.
Definition: lib.c:609
#define POP_CACHE_LEN
Definition: private.h:39
static const char * cache_id(const char *id)
Make a message-cache-compatible id.
Definition: pop.c:82
@ MUTT_PROGRESS_NET
Progress tracks bytes, according to $net_inc
Definition: lib.h:81
struct Progress * progress_new(enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:139
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:110
void progress_set_message(struct Progress *progress, const char *fmt,...) __attribute__((__format__(__printf__
void * edata
Driver-specific data.
Definition: email.h:74
void(* edata_free)(void **ptr)
Definition: email.h:90
POP-specific Account data -.
Definition: adata.h:37
char err_msg[POP_CMD_RESPONSE]
Definition: adata.h:56
struct PopCache cache[POP_CACHE_LEN]
Definition: adata.h:57
struct BodyCache * bcache
body cache
Definition: adata.h:55
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
+ Here is the call graph for this function: