POP Response Parser API

Prototype for a function to handle POP server responses. More...

Functions
static int	fetch_capa (const char *line, void *data)
	Parse CAPA response - Implements pop_fetch_t -.
static int	fetch_auth (const char *line, void *data)
	Parse AUTH response - Implements pop_fetch_t -.
static int	check_uidl (const char *line, void *data)
	Parse UIDL response - Implements pop_fetch_t -.
static int	fetch_message (const char *line, void *data)
	Parse a Message response - Implements pop_fetch_t -.
static int	fetch_uidl (const char *line, void *data)
	Parse UIDL response - Implements pop_fetch_t -.

Detailed Description

Prototype for a function to handle POP server responses.

Parameters

str	String to parse
data	Private data passed to pop_fetch_data()

Return values

0	Success
-1	Failure

Function Documentation

fetch_capa()

int fetch_capa ( const char * line, void * data )

static

Parse CAPA response - Implements pop_fetch_t -.

Parameters

line	List of capabilities
data	POP data

Return values

0

(always)

Definition at line 146 of file lib.c.

{
  struct PopAccountData *adata = data;
 
  if (mutt_istr_startswith(line, "SASL"))
  {
    const char *c = mutt_str_skip_email_wsp(line + 4);
    buf_strcpy(&adata->auth_list, c);
  }
  else if (mutt_istr_startswith(line, "STLS"))
  {
    adata->cmd_stls = true;
  }
  else if (mutt_istr_startswith(line, "USER"))
  {
    adata->cmd_user = 1;
  }
  else if (mutt_istr_startswith(line, "UIDL"))
  {
    adata->cmd_uidl = 1;
  }
  else if (mutt_istr_startswith(line, "TOP"))
  {
    adata->cmd_top = 1;
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

fetch_auth()

int fetch_auth ( const char * line, void * data )

static

Parse AUTH response - Implements pop_fetch_t -.

Parameters

line	List of authentication methods
data	POP data

Return values

0

(always)

Definition at line 181 of file lib.c.

{
  struct PopAccountData *adata = data;
 
  if (!buf_is_empty(&adata->auth_list))
  {
    buf_addstr(&adata->auth_list, " ");
  }
  buf_addstr(&adata->auth_list, line);
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

check_uidl()

int check_uidl ( const char * line, void * data )

static

Parse UIDL response - Implements pop_fetch_t -.

Parameters

line	String containing UIDL
data	POP data

Return values

0	Success
-1	Error

Find message with this UIDL and set refno.

Definition at line 576 of file lib.c.

{
  if (!line || !data)
    return -1;
 
  char *endp = NULL;
 
  errno = 0;
  unsigned int index = strtoul(line, &endp, 10);
  if ((errno != 0) || (endp == line))
    return -1;
  while (*endp == ' ')
    endp++;
 
  struct Mailbox *m = data;
  for (int i = 0; i < m->msg_count; i++)
  {
    struct PopEmailData *edata = pop_edata_get(m->emails[i]);
    if (mutt_str_equal(edata->uid, endp))
    {
      edata->refno = index;
      break;
    }
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

fetch_message()

int fetch_message ( const char * line, void * data )

static

Parse a Message response - Implements pop_fetch_t -.

Parameters

line	String to write
data	FILE pointer to write to

Return values

0	Success
-1	Failure

Save a Message to a file.

Definition at line 102 of file pop.c.

{
  FILE *fp = data;
 
  fputs(line, fp);
  if (fputc('\n', fp) == EOF)
    return -1;
 
  return 0;
}

Here is the caller graph for this function:

fetch_uidl()

int fetch_uidl ( const char * line, void * data )

static

Parse UIDL response - Implements pop_fetch_t -.

Parameters

line	String to parse
data	Mailbox

Return values

0	Success
-1	Failure

Definition at line 214 of file pop.c.

{
  struct Mailbox *m = data;
  struct PopAccountData *adata = pop_adata_get(m);
  char *endp = NULL;
 
  errno = 0;
  int index = strtol(line, &endp, 10);
  if ((errno != 0) || (endp == line))
    return -1;
  while (*endp == ' ')
    endp++;
  line = endp;
 
  /* uid must be at least be 1 byte */
  if (strlen(line) == 0)
    return -1;
 
  int i;
  for (i = 0; i < m->msg_count; i++)
  {
    struct PopEmailData *edata = pop_edata_get(m->emails[i]);
    if (mutt_str_equal(line, edata->uid))
      break;
  }
 
  if (i == m->msg_count)
  {
    if (m->msg_count >= POP_MAX_MESSAGES)
    {
      mutt_debug(LL_DEBUG1, "UIDL response limit reached (%d)\n", POP_MAX_MESSAGES);
      return -1;
    }
 
    mutt_debug(LL_DEBUG1, "new header %d %s\n", index, line);
 
    mx_alloc_memory(m, i);
 
    m->msg_count++;
    m->emails[i] = email_new();
 
    m->emails[i]->edata = pop_edata_new(line);
    m->emails[i]->edata_free = pop_edata_free;
  }
  else if (m->emails[i]->index != index - 1)
  {
    adata->clear_cache = true;
  }
 
  m->emails[i]->index = index - 1;
 
  struct PopEmailData *edata = pop_edata_get(m->emails[i]);
  edata->refno = index;
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function: