email.c File Reference

Dump an Email. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "email/lib.h"
#include "lib.h"
#include "attach/lib.h"
#include "ncrypt/lib.h"

Include dependency graph for email.c:

Go to the source code of this file.

Macros
#define	ADD_FLAG(F)
#define	ADDR_LIST(AL)
#define	OPT_STRING(S)
#define	ADD_FLAG(F)
#define	ADD_FLAG(F)
#define	ADD_FLAG(F)
#define	OPT_STRING(S)
#define	ADD_FLAG(F)

Functions
void	dump_addr_list (char *buf, size_t buflen, const struct AddressList *al, const char *name)
	Dump an address list.
void	dump_list_head (const struct ListHead *list, const char *name)
	Dump a list of strings.
void	dump_envelope (const struct Envelope *env)
	Dump an envelope.
void	dump_email (const struct Email *e)
	Dump an email message.
void	dump_param_list (const struct ParameterList *pl)
	Dump a parameter list.
void	dump_body (const struct Body *body)
	Dump a message body.
void	dump_attach (const struct AttachPtr *att)
	Dump an attachment.
char	body_name (const struct Body *b)
	Get the first character of a body.
void	dump_body_next (struct Buffer *buf, const struct Body *b)
	Dump the body tree structure.
void	dump_body_one_line (const struct Body *b)
	Dump body layout as a one-line summary.

Detailed Description

Dump an Email.

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

Macro Definition Documentation

ADD_FLAG [1/5]

#define ADD_FLAG

(

F

)

Value:

add_flag(buf, (env->changed & F), #F)

ADDR_LIST

#define ADDR_LIST

(

AL

)

Value:

dump_addr_list(arr, sizeof(arr), &env->AL, #AL)

OPT_STRING [1/2]

#define OPT_STRING

(

S

)

Value:

if (env->S)                                                                  \
mutt_debug(LL_DEBUG1, "\t%s: %s\n", #S, env->S)

ADD_FLAG [2/5]

#define ADD_FLAG

(

F

)

Value:

add_flag(buf, e->F, #F)

ADD_FLAG [3/5]

#define ADD_FLAG

(

F

)

Value:

add_flag(buf, (e->security & F), #F)

ADD_FLAG [4/5]

#define ADD_FLAG

(

F

)

Value:

add_flag(buf, body->F, #F)

OPT_STRING [2/2]

#define OPT_STRING

(

S

)

Value:

if (body->S)                                                                 \
mutt_debug(LL_DEBUG1, "\t%s: %s\n", #S, body->S)

ADD_FLAG [5/5]

#define ADD_FLAG

(

F

)

Value:

add_flag(buf, att->F, #F)

Function Documentation

dump_addr_list()

void dump_addr_list	(	char *	buf,
		size_t	buflen,
		const struct AddressList *	al,
		const char *	name )

Dump an address list.

Parameters

buf	Buffer to write to
buflen	Length of buffer
al	Address list to dump
name	Name of the list

Definition at line 47 of file email.c.

{
  if (!buf || !al)
    return;
  if (TAILQ_EMPTY(al))
    return;
 
  buf[0] = '\0';
  struct Buffer *tmpbuf = buf_pool_get();
  mutt_addrlist_write(al, tmpbuf, true);
  mutt_str_copy(buf, buf_string(tmpbuf), buflen);
  buf_pool_release(&tmpbuf);
 
  mutt_debug(LL_DEBUG1, "\t%s: %s\n", name, buf);
}

Here is the call graph for this function:

dump_list_head()

void dump_list_head	(	const struct ListHead *	list,
		const char *	name )

Dump a list of strings.

Parameters

list	List to dump
name	Name of the list

Definition at line 68 of file email.c.

{
  if (!list || !name)
    return;
  if (STAILQ_EMPTY(list))
    return;
 
  struct Buffer *buf = buf_pool_get();
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, list, entries)
  {
    if (!buf_is_empty(buf))
      buf_addch(buf, ',');
    buf_addstr(buf, np->data);
  }
 
  mutt_debug(LL_DEBUG1, "\t%s: %s\n", name, buf_string(buf));
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_envelope()

void dump_envelope

(

const struct Envelope *

env

)

Dump an envelope.

Parameters

env	Envelope to dump

Helper to add a flag to debug output

Helper to dump an address list with debug output

Helper to print optional string fields

Definition at line 93 of file email.c.

{
  mutt_debug(LL_DEBUG1, "Envelope\n");
 
  if (!env)
  {
    mutt_debug(LL_DEBUG1, "\tNULL pointer\n");
    return;
  }
 
  struct Buffer *buf = buf_pool_get();
  char arr[1024];

#define ADD_FLAG(F) add_flag(buf, (env->changed & F), #F)
  ADD_FLAG(MUTT_ENV_CHANGED_IRT);
  ADD_FLAG(MUTT_ENV_CHANGED_REFS);
  ADD_FLAG(MUTT_ENV_CHANGED_XLABEL);
  ADD_FLAG(MUTT_ENV_CHANGED_SUBJECT);
#undef ADD_FLAG
  mutt_debug(LL_DEBUG1, "\tchanged: %s\n", buf_is_empty(buf) ? "[NONE]" : buf_string(buf));

#define ADDR_LIST(AL) dump_addr_list(arr, sizeof(arr), &env->AL, #AL)
  ADDR_LIST(return_path);
  ADDR_LIST(from);
  ADDR_LIST(to);
  ADDR_LIST(cc);
  ADDR_LIST(bcc);
  ADDR_LIST(sender);
  ADDR_LIST(reply_to);
  ADDR_LIST(mail_followup_to);
  ADDR_LIST(x_original_to);
#undef ADDR_LIST

#define OPT_STRING(S)                                                          \
  if (env->S)                                                                  \
  mutt_debug(LL_DEBUG1, "\t%s: %s\n", #S, env->S)
  OPT_STRING(list_post);
  OPT_STRING(list_subscribe);
  OPT_STRING(list_unsubscribe);
  OPT_STRING(subject);
  OPT_STRING(real_subj);
  OPT_STRING(disp_subj);
  OPT_STRING(message_id);
  OPT_STRING(supersedes);
  OPT_STRING(date);
  OPT_STRING(x_label);
  OPT_STRING(organization);
  OPT_STRING(newsgroups);
  OPT_STRING(xref);
  OPT_STRING(followup_to);
  OPT_STRING(x_comment_to);
#undef OPT_STRING
 
  dump_list_head(&env->references, "references");
  dump_list_head(&env->in_reply_to, "in_reply_to");
  dump_list_head(&env->userhdrs, "userhdrs");
 
  if (!buf_is_empty(&env->spam))
    mutt_debug(LL_DEBUG1, "\tspam: %s\n", buf_string(&env->spam));
 
#ifdef USE_AUTOCRYPT
  if (env->autocrypt)
    mutt_debug(LL_DEBUG1, "\tautocrypt: %p\n", (void *) env->autocrypt);
  if (env->autocrypt_gossip)
    mutt_debug(LL_DEBUG1, "\tautocrypt_gossip: %p\n", (void *) env->autocrypt_gossip);
#endif
 
  buf_pool_release(&buf);
}

Here is the call graph for this function:

dump_email()

void dump_email

(

const struct Email *

e

)

Dump an email message.

Parameters

e	Email to dump

Helper to add an email flag to debug output

Helper to add a security flag to debug output

Definition at line 170 of file email.c.

{
  mutt_debug(LL_DEBUG1, "Email\n");
 
  if (!e)
  {
    mutt_debug(LL_DEBUG1, "\tNULL pointer\n");
    return;
  }
 
  struct Buffer *buf = buf_pool_get();
  char arr[256];
 
  mutt_debug(LL_DEBUG1, "\tpath: %s\n", e->path);

#define ADD_FLAG(F) add_flag(buf, e->F, #F)
  ADD_FLAG(active);
  ADD_FLAG(attach_del);
  ADD_FLAG(attach_valid);
  ADD_FLAG(changed);
  ADD_FLAG(collapsed);
  ADD_FLAG(deleted);
  ADD_FLAG(display_subject);
  ADD_FLAG(expired);
  ADD_FLAG(flagged);
  ADD_FLAG(matched);
  ADD_FLAG(mime);
  ADD_FLAG(old);
  ADD_FLAG(purge);
  ADD_FLAG(quasi_deleted);
  ADD_FLAG(read);
  ADD_FLAG(recip_valid);
  ADD_FLAG(replied);
  ADD_FLAG(searched);
  ADD_FLAG(subject_changed);
  ADD_FLAG(superseded);
  ADD_FLAG(tagged);
  ADD_FLAG(threaded);
  ADD_FLAG(trash);
  ADD_FLAG(visible);
#undef ADD_FLAG
  mutt_debug(LL_DEBUG1, "\tFlags: %s\n", buf_is_empty(buf) ? "[NONE]" : buf_string(buf));

#define ADD_FLAG(F) add_flag(buf, (e->security & F), #F)
  buf_reset(buf);
  ADD_FLAG(SEC_ENCRYPT);
  ADD_FLAG(SEC_SIGN);
  ADD_FLAG(SEC_GOODSIGN);
  ADD_FLAG(SEC_BADSIGN);
  ADD_FLAG(SEC_PARTSIGN);
  ADD_FLAG(SEC_SIGNOPAQUE);
  ADD_FLAG(SEC_KEYBLOCK);
  ADD_FLAG(SEC_INLINE);
  ADD_FLAG(SEC_OPPENCRYPT);
  ADD_FLAG(SEC_AUTOCRYPT);
  ADD_FLAG(SEC_AUTOCRYPT_OVERRIDE);
  ADD_FLAG(APPLICATION_PGP);
  ADD_FLAG(APPLICATION_SMIME);
  ADD_FLAG(PGP_TRADITIONAL_CHECKED);
#undef ADD_FLAG
  mutt_debug(LL_DEBUG1, "\tSecurity: %s\n", buf_is_empty(buf) ? "[NONE]" : buf_string(buf));
 
  mutt_date_make_tls(arr, sizeof(arr), e->date_sent);
  mutt_debug(LL_DEBUG1, "\tSent: %s (%c%02u%02u)\n", arr,
             e->zoccident ? '-' : '+', e->zhours, e->zminutes);
 
  mutt_date_make_tls(arr, sizeof(arr), e->received);
  mutt_debug(LL_DEBUG1, "\tRecv: %s\n", arr);
 
  buf_pool_release(&buf);
 
  mutt_debug(LL_DEBUG1, "\tnum_hidden: %ld\n", e->num_hidden);
  mutt_debug(LL_DEBUG1, "\trecipient: %d\n", e->recipient);
  mutt_debug(LL_DEBUG1, "\toffset: %ld\n", e->offset);
  mutt_debug(LL_DEBUG1, "\tlines: %d\n", e->lines);
  mutt_debug(LL_DEBUG1, "\tindex: %d\n", e->index);
  mutt_debug(LL_DEBUG1, "\tmsgno: %d\n", e->msgno);
  mutt_debug(LL_DEBUG1, "\tvnum: %d\n", e->vnum);
  mutt_debug(LL_DEBUG1, "\tscore: %d\n", e->score);
  mutt_debug(LL_DEBUG1, "\tattach_total: %d\n", e->attach_total);
  // if (e->maildir_flags)
  //   mutt_debug(LL_DEBUG1, "\tmaildir_flags: %s\n", e->maildir_flags);
 
  // struct MuttThread *thread
  // struct Envelope *env
  // struct Body *content
  // struct TagList tags
 
  // void *edata
}

Here is the call graph for this function:

dump_param_list()

void dump_param_list

(

const struct ParameterList *

pl

)

Dump a parameter list.

Parameters

pl	Parameter list to dump

Definition at line 267 of file email.c.

{
  mutt_debug(LL_DEBUG1, "\tparameters\n");
 
  if (!pl)
  {
    mutt_debug(LL_DEBUG1, "\tNULL pointer\n");
    return;
  }
 
  if (TAILQ_EMPTY(pl))
  {
    mutt_debug(LL_DEBUG1, "\tempty\n");
    return;
  }
 
  struct Parameter *np = NULL;
  TAILQ_FOREACH(np, pl, entries)
  {
    mutt_debug(LL_DEBUG1, "\t\t%s = %s\n", NONULL(np->attribute), NONULL(np->value));
  }
}

Here is the caller graph for this function:

dump_body()

void dump_body

(

const struct Body *

body

)

Dump a message body.

Parameters

body	Body to dump

Helper to add a body flag to debug output

Helper to print optional string fields in body

Definition at line 294 of file email.c.

{
  mutt_debug(LL_DEBUG1, "Body\n");
 
  if (!body)
  {
    mutt_debug(LL_DEBUG1, "\tNULL pointer\n");
    return;
  }
 
  struct Buffer *buf = buf_pool_get();
  char arr[256];

#define ADD_FLAG(F) add_flag(buf, body->F, #F)
  ADD_FLAG(attach_qualifies);
  ADD_FLAG(badsig);
  ADD_FLAG(deleted);
  ADD_FLAG(force_charset);
  ADD_FLAG(goodsig);
#ifdef USE_AUTOCRYPT
  ADD_FLAG(is_autocrypt);
#endif
  ADD_FLAG(noconv);
  ADD_FLAG(tagged);
  ADD_FLAG(unlink);
  ADD_FLAG(use_disp);
  ADD_FLAG(warnsig);
#undef ADD_FLAG
  mutt_debug(LL_DEBUG1, "\tFlags: %s\n", buf_is_empty(buf) ? "[NONE]" : buf_string(buf));

#define OPT_STRING(S)                                                          \
  if (body->S)                                                                 \
  mutt_debug(LL_DEBUG1, "\t%s: %s\n", #S, body->S)
  OPT_STRING(charset);
  OPT_STRING(description);
  OPT_STRING(d_filename);
  OPT_STRING(filename);
  OPT_STRING(form_name);
  OPT_STRING(language);
  OPT_STRING(subtype);
  OPT_STRING(xtype);
#undef OPT_STRING
 
  mutt_debug(LL_DEBUG1, "\thdr_offset: %ld\n", body->hdr_offset);
  mutt_debug(LL_DEBUG1, "\toffset: %ld\n", body->offset);
  mutt_debug(LL_DEBUG1, "\tlength: %ld\n", body->length);
  mutt_debug(LL_DEBUG1, "\tattach_count: %d\n", body->attach_count);
 
  mutt_debug(LL_DEBUG1, "\tcontent type: %s\n", name_content_type(body->type));
  mutt_debug(LL_DEBUG1, "\tcontent encoding: %s\n", name_content_encoding(body->encoding));
  mutt_debug(LL_DEBUG1, "\tcontent disposition: %s\n",
             name_content_disposition(body->disposition));
 
  if (body->stamp != 0)
  {
    mutt_date_make_tls(arr, sizeof(arr), body->stamp);
    mutt_debug(LL_DEBUG1, "\tstamp: %s\n", arr);
  }
 
  dump_param_list(&body->parameter);
 
  // struct Content *content;        ///< Detailed info about the content of the attachment.
  // struct Body *next;              ///< next attachment in the list
  // struct Body *parts;             ///< parts of a multipart or message/rfc822
  // struct Email *email;            ///< header information for message/rfc822
  // struct AttachPtr *aptr;         ///< Menu information, used in recvattach.c
  // struct Envelope *mime_headers;  ///< Memory hole protected headers
 
  if (body->next)
  {
    mutt_debug(LL_DEBUG1, "-NEXT-------------------------\n");
    dump_body(body->next);
  }
  if (body->parts)
  {
    mutt_debug(LL_DEBUG1, "-PARTS-------------------------\n");
    dump_body(body->parts);
  }
  if (body->next || body->parts)
    mutt_debug(LL_DEBUG1, "--------------------------\n");
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_attach()

void dump_attach

(

const struct AttachPtr *

att

)

Dump an attachment.

Parameters

att	Attachment to dump

Helper to add an attach flag to debug output

Definition at line 383 of file email.c.

{
  mutt_debug(LL_DEBUG1, "AttachPtr\n");
 
  if (!att)
  {
    mutt_debug(LL_DEBUG1, "\tNULL pointer\n");
    return;
  }
 
  struct Buffer *buf = buf_pool_get();

#define ADD_FLAG(F) add_flag(buf, att->F, #F)
  ADD_FLAG(unowned);
  ADD_FLAG(decrypted);
  ADD_FLAG(collapsed);
#undef ADD_FLAG
 
  if (att->fp)
    mutt_debug(LL_DEBUG1, "\tfp: %p (%d)\n", (void *) att->fp, fileno(att->fp));
  mutt_debug(LL_DEBUG1, "\tparent_type: %d\n", att->parent_type);
  mutt_debug(LL_DEBUG1, "\tlevel: %d\n", att->level);
  mutt_debug(LL_DEBUG1, "\tnum: %d\n", att->num);
 
  // struct Body *content; ///< Attachment
  buf_pool_release(&buf);
}

Here is the call graph for this function:

body_name()

char body_name

(

const struct Body *

b

)

Get the first character of a body.

Parameters

b	Body to examine

Return values

char	Character from description, filename or indicator

Definition at line 417 of file email.c.

{
  if (!b)
    return '!';
 
  if (b->type == TYPE_MULTIPART)
    return '&';
 
  if (b->description)
    return b->description[0];
 
  if (b->filename)
  {
    const char *base = basename(b->filename);
    if (mutt_str_startswith(base, "neomutt-"))
      return '0';
 
    return base[0];
  }
 
  return '!';
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_body_next()

void dump_body_next	(	struct Buffer *	buf,
		const struct Body *	b )

Dump the body tree structure.

Parameters

buf	Buffer to write to
b	Body to dump

Definition at line 445 of file email.c.

{
  if (!b)
    return;
 
  buf_addstr(buf, "<");
  for (; b; b = b->next)
  {
    buf_add_printf(buf, "%c", body_name(b));
    dump_body_next(buf, b->parts);
    if (b->next)
      buf_addch(buf, ',');
  }
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_body_one_line()

void dump_body_one_line

(

const struct Body *

b

)

Dump body layout as a one-line summary.

Parameters

b	Body to summarize

Definition at line 465 of file email.c.

{
  if (!b)
    return;
 
  struct Buffer *buf = buf_pool_get();
  buf_addstr(buf, "Body layout: ");
  dump_body_next(buf, b);
 
  mutt_message("%s", buf_string(buf));
  buf_pool_release(&buf);
}

Here is the call graph for this function: