hcache.h File Reference

Maildir Header Cache. More...

#include <stdlib.h>

Include dependency graph for hcache.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	maildir_hcache_close (struct HeaderCache **ptr)
	Close the Header Cache.
int	maildir_hcache_delete (struct HeaderCache *hc, struct Email *e)
	Delete an Email from the Header Cache.
struct HeaderCache *	maildir_hcache_open (struct Mailbox *m)
	Open the Header Cache.
struct Email *	maildir_hcache_read (struct HeaderCache *hc, struct Email *e, const char *fn)
	Read an Email from the Header Cache.
int	maildir_hcache_store (struct HeaderCache *hc, struct Email *e)
	Save an Email to the Header Cache.

Detailed Description

Maildir Header Cache.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file hcache.h.

Function Documentation

maildir_hcache_close()

void maildir_hcache_close

(

struct HeaderCache **

ptr

)

Close the Header Cache.

Parameters

ptr	Header Cache

Definition at line 69 of file hcache.c.

{
  hcache_close(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_hcache_delete()

int maildir_hcache_delete	(	struct HeaderCache *	hc,
		struct Email *	e
	)

Delete an Email from the Header Cache.

Parameters

hc	Header Cache
e	Email to delete

Return values

0	Success
-1	Error

Definition at line 81 of file hcache.c.

{
  if (!hc || !e)
    return 0;
 
  const char *key = maildir_hcache_key(e);
  size_t keylen = maildir_hcache_keylen(key);
 
  return hcache_delete_email(hc, key, keylen);
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_hcache_open()

struct HeaderCache * maildir_hcache_open

(

struct Mailbox *

m

)

Open the Header Cache.

Parameters

m

Mailbox

Definition at line 96 of file hcache.c.

{
  if (!m)
    return NULL;
 
  const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
 
  return hcache_open(c_header_cache, mailbox_path(m), NULL, true);
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_hcache_read()

struct Email * maildir_hcache_read	(	struct HeaderCache *	hc,
		struct Email *	e,
		const char *	fn
	)

Read an Email from the Header Cache.

Parameters

[in]	hc	Header Cache
[in]	e	Email to find
[in]	fn	Filename

Return values

ptr	Email from Header Cache

Definition at line 113 of file hcache.c.

{
  if (!hc || !e)
    return NULL;
 
  struct stat st_lastchanged = { 0 };
  int rc = 0;
 
  const char *key = maildir_hcache_key(e);
  size_t keylen = maildir_hcache_keylen(key);
 
  struct HCacheEntry hce = hcache_fetch_email(hc, key, keylen, 0);
  if (!hce.email)
    return NULL;
 
  const bool c_maildir_header_cache_verify = cs_subset_bool(NeoMutt->sub, "maildir_header_cache_verify");
  if (c_maildir_header_cache_verify)
    rc = stat(fn, &st_lastchanged);
 
  if ((rc == 0) && (st_lastchanged.st_mtime <= hce.uidvalidity))
  {
    hce.email->edata = maildir_edata_new();
    hce.email->edata_free = maildir_edata_free;
    hce.email->old = e->old;
    hce.email->path = mutt_str_dup(e->path);
    maildir_parse_flags(hce.email, fn);
  }
  else
  {
    email_free(&hce.email);
  }
 
  return hce.email;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_hcache_store()

int maildir_hcache_store	(	struct HeaderCache *	hc,
		struct Email *	e
	)

Save an Email to the Header Cache.

Parameters

hc	Header Cache
e	Email to save

Return values

0	Success
-1	Error

Definition at line 155 of file hcache.c.

{
  if (!hc || !e)
    return 0;
 
  const char *key = maildir_hcache_key(e);
  size_t keylen = maildir_hcache_keylen(key);
 
  return hcache_store_email(hc, key, keylen, e, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function: