path_probe()

Does this Mailbox type recognise this path? More...

Collaboration diagram for path_probe():

Functions
static enum MailboxType	comp_path_probe (const char *path, const struct stat *st)
	Is this a compressed Mailbox?
enum MailboxType	imap_path_probe (const char *path, const struct stat *st)
	Is this an IMAP Mailbox?
enum MailboxType	maildir_path_probe (const char *path, const struct stat *st)
	Is this a Maildir Mailbox?
enum MailboxType	mbox_path_probe (const char *path, const struct stat *st)
	Is this an mbox Mailbox?
static enum MailboxType	mh_path_probe (const char *path, const struct stat *st)
	Is this an mh Mailbox?
enum MailboxType	nntp_path_probe (const char *path, const struct stat *st)
	Is this an NNTP Mailbox?
enum MailboxType	nm_path_probe (const char *path, const struct stat *st)
	Is this a Notmuch Mailbox?
enum MailboxType	pop_path_probe (const char *path, const struct stat *st)
	Is this a POP Mailbox?

Detailed Description

Does this Mailbox type recognise this path?

Parameters

path	Path to examine
st	stat buffer (for local filesystems)

Return values

enum	MailboxType, e.g. MUTT_IMAP

Precondition

path is not NULL

Function Documentation

comp_path_probe()

static enum MailboxType comp_path_probe ( const char * path, const struct stat * st )

static

Is this a compressed Mailbox?

• Implements MxOps::path_probe() -

Definition at line 863 of file compress.c.

{
  if (!st || !S_ISREG(st->st_mode))
    return MUTT_UNKNOWN;
 
  if (mutt_comp_can_read(path))
    return MUTT_COMPRESSED;
 
  return MUTT_UNKNOWN;
}

Here is the call graph for this function:

imap_path_probe()

enum MailboxType imap_path_probe	(	const char *	path,
		const struct stat *	st )

Is this an IMAP Mailbox?

• Implements MxOps::path_probe() -

Definition at line 2683 of file imap.c.

{
  if (mutt_istr_startswith(path, "imap://"))
    return MUTT_IMAP;
 
  if (mutt_istr_startswith(path, "imaps://"))
    return MUTT_IMAP;
 
  return MUTT_UNKNOWN;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_path_probe()

enum MailboxType maildir_path_probe	(	const char *	path,
		const struct stat *	st )

Is this a Maildir Mailbox?

• Implements MxOps::path_probe() -

Definition at line 94 of file path.c.

{
  if (!st || !S_ISDIR(st->st_mode))
    return MUTT_UNKNOWN;
 
  char sub[PATH_MAX] = { 0 };
  struct stat stsub = { 0 };
  char *subs[] = { "cur", "new", "tmp" };
  for (size_t i = 0; i < countof(subs); i++)
  {
    snprintf(sub, sizeof(sub), "%s/%s", path, subs[i]);
    if ((stat(sub, &stsub) != 0) || !S_ISDIR(stsub.st_mode))
      return MUTT_UNKNOWN;
  }
 
  return MUTT_MAILDIR;
}

mbox_path_probe()

enum MailboxType mbox_path_probe	(	const char *	path,
		const struct stat *	st )

Is this an mbox Mailbox?

• Implements MxOps::path_probe() -

Definition at line 1571 of file mbox.c.

{
  if (!st)
    return MUTT_UNKNOWN;
 
  if (S_ISDIR(st->st_mode))
    return MUTT_UNKNOWN;
 
  if (st->st_size == 0)
    return MUTT_MBOX;
 
  FILE *fp = mutt_file_fopen(path, "r");
  if (!fp)
    return MUTT_UNKNOWN;
 
  int ch;
  while ((ch = fgetc(fp)) != EOF)
  {
    /* Some mailbox creation tools erroneously append a blank line to
     * a file before appending a mail message.  This allows neomutt to
     * detect type for and thus open those files. */
    if ((ch != '\n') && (ch != '\r'))
    {
      ungetc(ch, fp);
      break;
    }
  }
 
  enum MailboxType type = MUTT_UNKNOWN;
  char tmp[256] = { 0 };
  if (fgets(tmp, sizeof(tmp), fp))
  {
    if (mutt_str_startswith(tmp, "From "))
      type = MUTT_MBOX;
    else if (mutt_str_equal(tmp, MMDF_SEP))
      type = MUTT_MMDF;
  }
  mutt_file_fclose(&fp);
 
  const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
  if (!c_check_mbox_size)
  {
    /* need to restore the times here, the file was not really accessed,
     * only the type was accessed.  This is important, because detection
     * of "new mail" depends on those times set correctly.  */
#ifdef HAVE_UTIMENSAT
    struct timespec ts[2] = { { 0 }, { 0 } };
    mutt_file_get_stat_timespec(&ts[0], &st, MUTT_STAT_ATIME);
    mutt_file_get_stat_timespec(&ts[1], &st, MUTT_STAT_MTIME);
    utimensat(AT_FDCWD, path, ts, 0);
#else
    struct utimbuf times = { 0 };
    times.actime = st->st_atime;
    times.modtime = st->st_mtime;
    utime(path, &times);
#endif
  }
 
  return type;
}

Here is the call graph for this function:

mh_path_probe()

static enum MailboxType mh_path_probe ( const char * path, const struct stat * st )

static

Is this an mh Mailbox?

• Implements MxOps::path_probe() -

Definition at line 1203 of file mh.c.

{
  if (!st || !S_ISDIR(st->st_mode))
    return MUTT_UNKNOWN;
 
  char tmp[PATH_MAX] = { 0 };
 
  snprintf(tmp, sizeof(tmp), "%s/.mh_sequences", path);
  if (access(tmp, F_OK) == 0)
    return MUTT_MH;
 
  snprintf(tmp, sizeof(tmp), "%s/.xmhcache", path);
  if (access(tmp, F_OK) == 0)
    return MUTT_MH;
 
  snprintf(tmp, sizeof(tmp), "%s/.mew_cache", path);
  if (access(tmp, F_OK) == 0)
    return MUTT_MH;
 
  snprintf(tmp, sizeof(tmp), "%s/.mew-cache", path);
  if (access(tmp, F_OK) == 0)
    return MUTT_MH;
 
  snprintf(tmp, sizeof(tmp), "%s/.sylpheed_cache", path);
  if (access(tmp, F_OK) == 0)
    return MUTT_MH;
 
  /* ok, this isn't an mh folder, but mh mode can be used to read
   * Usenet news from the spool.  */
 
  snprintf(tmp, sizeof(tmp), "%s/.overview", path);
  if (access(tmp, F_OK) == 0)
    return MUTT_MH;
 
  return MUTT_UNKNOWN;
}

nntp_path_probe()

enum MailboxType nntp_path_probe	(	const char *	path,
		const struct stat *	st )

Is this an NNTP Mailbox?

• Implements MxOps::path_probe() -

Definition at line 2797 of file nntp.c.

{
  if (mutt_istr_startswith(path, "news://"))
    return MUTT_NNTP;
 
  if (mutt_istr_startswith(path, "snews://"))
    return MUTT_NNTP;
 
  return MUTT_UNKNOWN;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_path_probe()

enum MailboxType nm_path_probe	(	const char *	path,
		const struct stat *	st )

Is this a Notmuch Mailbox?

• Implements MxOps::path_probe() -

Definition at line 2478 of file notmuch.c.

{
  if (!mutt_istr_startswith(path, NmUrlProtocol))
    return MUTT_UNKNOWN;
 
  return MUTT_NOTMUCH;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pop_path_probe()

enum MailboxType pop_path_probe	(	const char *	path,
		const struct stat *	st )

Is this a POP Mailbox?

• Implements MxOps::path_probe() -

Definition at line 1177 of file pop.c.

{
  if (mutt_istr_startswith(path, "pop://"))
    return MUTT_POP;
 
  if (mutt_istr_startswith(path, "pops://"))
    return MUTT_POP;
 
  return MUTT_UNKNOWN;
}

Here is the call graph for this function:

Here is the caller graph for this function: