Mail Sorting API

Prototype for an email comparison function. More...

Functions
int	nntp_compare_order (const struct Email *a, const struct Email *b, bool reverse)
	Sort to mailbox order - Implements sort_mail_t -. More...
static int	compare_score (const struct Email *a, const struct Email *b, bool reverse)
	Compare two emails using their scores - Implements sort_mail_t -. More...
static int	compare_size (const struct Email *a, const struct Email *b, bool reverse)
	Compare the size of two emails - Implements sort_mail_t -. More...
static int	compare_date_sent (const struct Email *a, const struct Email *b, bool reverse)
	Compare the sent date of two emails - Implements sort_mail_t -. More...
static int	compare_subject (const struct Email *a, const struct Email *b, bool reverse)
	Compare the subject of two emails - Implements sort_mail_t -. More...
static int	compare_to (const struct Email *a, const struct Email *b, bool reverse)
	Compare the 'to' fields of two emails - Implements sort_mail_t -. More...
static int	compare_from (const struct Email *a, const struct Email *b, bool reverse)
	Compare the 'from' fields of two emails - Implements sort_mail_t -. More...
static int	compare_date_received (const struct Email *a, const struct Email *b, bool reverse)
	Compare the date received of two emails - Implements sort_mail_t -. More...
static int	compare_order (const struct Email *a, const struct Email *b, bool reverse)
	Restore the 'unsorted' order of emails - Implements sort_mail_t -. More...
static int	compare_spam (const struct Email *a, const struct Email *b, bool reverse)
	Compare the spam values of two emails - Implements sort_mail_t -. More...
static int	compare_label (const struct Email *a, const struct Email *b, bool reverse)
	Compare the labels of two emails - Implements sort_mail_t -. More...

Detailed Description

Prototype for an email comparison function.

Parameters

a	First item
b	Second item
reverse	true if this is a reverse sort (smaller b precedes a)

Return values

<0	a precedes b
0	a and b are identical
>0	b precedes a

Function Documentation

nntp_compare_order()

int nntp_compare_order	(	const struct Email *	a,
		const struct Email *	b,
		bool	reverse
	)

Sort to mailbox order - Implements sort_mail_t -.

Definition at line 2313 of file nntp.c.

{
  anum_t na = nntp_edata_get((struct Email *) a)->article_num;
  anum_t nb = nntp_edata_get((struct Email *) b)->article_num;
  int result = (na == nb) ? 0 : (na > nb) ? 1 : -1;
  return reverse ? -result : result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compare_score()

static int compare_score ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare two emails using their scores - Implements sort_mail_t -.

Definition at line 81 of file sort.c.

{
  int result = mutt_numeric_cmp(b->score, a->score); /* note that this is reverse */
  return reverse ? -result : result;
}

Here is the caller graph for this function:

compare_size()

static int compare_size ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the size of two emails - Implements sort_mail_t -.

Definition at line 90 of file sort.c.

{
  int result = mutt_numeric_cmp(a->body->length, b->body->length);
  return reverse ? -result : result;
}

Here is the caller graph for this function:

compare_date_sent()

static int compare_date_sent ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the sent date of two emails - Implements sort_mail_t -.

Definition at line 99 of file sort.c.

{
  int result = mutt_numeric_cmp(a->date_sent, b->date_sent);
  return reverse ? -result : result;
}

Here is the caller graph for this function:

compare_subject()

static int compare_subject ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the subject of two emails - Implements sort_mail_t -.

Definition at line 108 of file sort.c.

{
  int rc;
 
  if (!a->env->real_subj)
  {
    if (!b->env->real_subj)
      rc = compare_date_sent(a, b, false);
    else
      rc = -1;
  }
  else if (!b->env->real_subj)
  {
    rc = 1;
  }
  else
  {
    rc = mutt_istr_cmp(a->env->real_subj, b->env->real_subj);
  }
  return reverse ? -rc : rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compare_to()

static int compare_to ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the 'to' fields of two emails - Implements sort_mail_t -.

Definition at line 161 of file sort.c.

{
  char fa[128] = { 0 };
 
  mutt_str_copy(fa, mutt_get_name(TAILQ_FIRST(&a->env->to)), sizeof(fa));
  const char *fb = mutt_get_name(TAILQ_FIRST(&b->env->to));
  int result = mutt_istrn_cmp(fa, fb, sizeof(fa));
  return reverse ? -result : result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compare_from()

static int compare_from ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the 'from' fields of two emails - Implements sort_mail_t -.

Definition at line 174 of file sort.c.

{
  char fa[128] = { 0 };
 
  mutt_str_copy(fa, mutt_get_name(TAILQ_FIRST(&a->env->from)), sizeof(fa));
  const char *fb = mutt_get_name(TAILQ_FIRST(&b->env->from));
  int result = mutt_istrn_cmp(fa, fb, sizeof(fa));
  return reverse ? -result : result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compare_date_received()

static int compare_date_received ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the date received of two emails - Implements sort_mail_t -.

Definition at line 187 of file sort.c.

{
  int result = mutt_numeric_cmp(a->received, b->received);
  return reverse ? -result : result;
}

Here is the caller graph for this function:

compare_order()

static int compare_order ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Restore the 'unsorted' order of emails - Implements sort_mail_t -.

Definition at line 196 of file sort.c.

{
  int result = mutt_numeric_cmp(a->index, b->index);
  return reverse ? -result : result;
}

Here is the caller graph for this function:

compare_spam()

static int compare_spam ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the spam values of two emails - Implements sort_mail_t -.

Definition at line 205 of file sort.c.

{
  char *aptr = NULL, *bptr = NULL;
  int ahas, bhas;
  int result = 0;
  double difference;
 
  /* Firstly, require spam attributes for both msgs */
  /* to compare. Determine which msgs have one.     */
  ahas = a->env && !buf_is_empty(&a->env->spam);
  bhas = b->env && !buf_is_empty(&b->env->spam);
 
  /* If one msg has spam attr but other does not, sort the one with first. */
  if (ahas && !bhas)
    return reverse ? -1 : 1;
  if (!ahas && bhas)
    return reverse ? 1 : -1;
 
  /* Else, if neither has a spam attr, presume equality. Fall back on aux. */
  if (!ahas && !bhas)
    return 0;
 
  /* Both have spam attrs. */
 
  /* preliminary numeric examination */
  difference = (strtod(a->env->spam.data, &aptr) - strtod(b->env->spam.data, &bptr));
 
  /* map double into comparison (-1, 0, or 1) */
  result = ((difference < 0.0) ? -1 : (difference > 0.0) ? 1 : 0);
 
  /* If either aptr or bptr is equal to data, there is no numeric    */
  /* value for that spam attribute. In this case, compare lexically. */
  if ((aptr == a->env->spam.data) || (bptr == b->env->spam.data))
  {
    result = mutt_str_cmp(aptr, bptr);
    return reverse ? -result : result;
  }
 
  /* Otherwise, we have numeric value for both attrs. If these values */
  /* are equal, then we first fall back upon string comparison, then  */
  /* upon auxiliary sort.                                             */
  if (result == 0)
    result = mutt_str_cmp(aptr, bptr);
  return reverse ? -result : result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compare_label()

static int compare_label ( const struct Email *  a, const struct Email *  b, bool  reverse  )

static

Compare the labels of two emails - Implements sort_mail_t -.

Definition at line 254 of file sort.c.

{
  int ahas, bhas, result = 0;
 
  /* As with compare_spam, not all messages will have the x-label
   * property.  Blank X-Labels are treated as null in the index
   * display, so we'll consider them as null for sort, too.       */
  ahas = a->env && a->env->x_label && *(a->env->x_label);
  bhas = b->env && b->env->x_label && *(b->env->x_label);
 
  /* First we bias toward a message with a label, if the other does not. */
  if (ahas && !bhas)
    return reverse ? 1 : -1;
  if (!ahas && bhas)
    return reverse ? -1 : 1;
 
  /* If neither has a label, use aux sort. */
  if (!ahas && !bhas)
    return 0;
 
  /* If both have a label, we just do a lexical compare. */
  result = mutt_istr_cmp(a->env->x_label, b->env->x_label);
  return reverse ? -result : result;
}

Here is the call graph for this function:

Here is the caller graph for this function: