msg_set.c File Reference

IMAP Message Sets. More...

#include "config.h"
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "msg_set.h"

Include dependency graph for msg_set.c:

Go to the source code of this file.

Functions
int	imap_sort_uid (const void *a, const void *b, void *sdata)
	Compare two UIDs - Implements sort_t -.
int	imap_make_msg_set (struct UidArray *uida, struct Buffer *buf, int *pos)
	Generate a compressed message set of UIDs.
int	imap_exec_msg_set (struct ImapAccountData *adata, const char *pre, const char *post, struct UidArray *uida)
	Execute a command using a set of UIDs.

Variables
int	ImapMaxCmdlen = 8192
	Maximum length of IMAP commands before they must be split.

Detailed Description

IMAP Message Sets.

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 msg_set.c.

Function Documentation

imap_make_msg_set()

int imap_make_msg_set	(	struct UidArray *	uida,
		struct Buffer *	buf,
		int *	pos
	)

Generate a compressed message set of UIDs.

Parameters

uida	Array of UIDs
buf	Buffer for message set
pos	Cursor used for multiple calls to this function

Return values

num	Number of UIDs processed

Compress a sorted list of UIDs, e.g.

• 1,2,3,4,6,8,9,10 becomes 1:4,6,8:10

Definition at line 73 of file msg_set.c.

{
  if (!uida || !buf || !pos)
    return 0;
 
  const size_t array_size = ARRAY_SIZE(uida);
  if ((array_size == 0) || (*pos >= array_size))
    return 0;
 
  int count = 1; // Number of UIDs added to the set
  size_t i = *pos;
  unsigned int start = *ARRAY_GET(uida, i);
  unsigned int prev = start;
 
  for (i++; (i < array_size) && (buf_len(buf) < ImapMaxCmdlen); i++, count++)
  {
    unsigned int uid = *ARRAY_GET(uida, i);
 
    // Keep adding to current set
    if (uid == (prev + 1))
    {
      prev = uid;
      continue;
    }
 
    // End the current set
    if (start == prev)
      buf_add_printf(buf, "%u,", start);
    else
      buf_add_printf(buf, "%u:%u,", start, prev);
 
    // Start a new set
    start = uid;
    prev = uid;
  }
 
  if (start == prev)
    buf_add_printf(buf, "%u", start);
  else
    buf_add_printf(buf, "%u:%u", start, prev);
 
  *pos = i;
 
  return count;
}

Here is the call graph for this function:

Here is the caller graph for this function:

imap_exec_msg_set()

int imap_exec_msg_set	(	struct ImapAccountData *	adata,
		const char *	pre,
		const char *	post,
		struct UidArray *	uida
	)

Execute a command using a set of UIDs.

Parameters

adata	Imap Account data
pre	Prefix commands
post	Postfix commands
uida	Sorted array of UIDs

Return values

num	Number of messages sent
-1	Error

Commands are of the form: TAG PRE MESSAGE-SET POST e.g. A01 UID COPY 1:4 MAILBOX

Note

Must be flushed with imap_exec()

Definition at line 133 of file msg_set.c.

{
  struct Buffer *cmd = buf_pool_get();
 
  int count = 0;
  int pos = 0;
  int rc = 0;
 
  do
  {
    buf_reset(cmd);
    buf_add_printf(cmd, "%s ", pre);
    rc = imap_make_msg_set(uida, cmd, &pos);
    if (rc > 0)
    {
      buf_add_printf(cmd, " %s", post);
      if (imap_exec(adata, buf_string(cmd), IMAP_CMD_QUEUE) != IMAP_EXEC_SUCCESS)
      {
        rc = -1;
        goto out;
      }
      count += rc;
    }
  } while (rc > 0);
 
  rc = count;
 
out:
  buf_pool_release(&cmd);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ImapMaxCmdlen

int ImapMaxCmdlen = 8192

Maximum length of IMAP commands before they must be split.

This is suggested in RFC7162 (dated 2014).

• https://datatracker.ietf.org/doc/html/rfc7162#section-4

Definition at line 50 of file msg_set.c.