copy_email.h File Reference

Duplicate the structure of an entire email. More...

#include "config.h"
#include <stdint.h>
#include <stdio.h>

Include dependency graph for copy_email.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MUTT_CM_NO_FLAGS   0
	No flags are set.
#define	MUTT_CM_NOHEADER   (1 << 0)
	Don't copy the message header.
#define	MUTT_CM_PREFIX   (1 << 1)
	Quote the header and body.
#define	MUTT_CM_DECODE   (1 << 2)
	Decode the message body into text/plain.
#define	MUTT_CM_DISPLAY   (1 << 3)
	Output is displayed to the user.
#define	MUTT_CM_UPDATE   (1 << 4)
	Update structs on sync.
#define	MUTT_CM_WEED   (1 << 5)
	Weed message/rfc822 attachment headers.
#define	MUTT_CM_CHARCONV   (1 << 6)
	Perform character set conversions.
#define	MUTT_CM_PRINTING   (1 << 7)
	Printing the message - display light.
#define	MUTT_CM_REPLYING   (1 << 8)
	Replying the message.
#define	MUTT_CM_DECODE_PGP   (1 << 9)
	Used for decoding PGP messages.
#define	MUTT_CM_DECODE_SMIME   (1 << 10)
	Used for decoding S/MIME messages.
#define	MUTT_CM_VERIFY   (1 << 11)
	Do signature verification.
#define	MUTT_CM_DECODE_CRYPT   (MUTT_CM_DECODE_PGP | MUTT_CM_DECODE_SMIME)
	Combination flag for decoding any kind of cryptography (PGP or S/MIME)
#define	CH_NO_FLAGS   0
	No flags are set.
#define	CH_UPDATE   (1 << 0)
	Update the status and x-status fields?
#define	CH_WEED   (1 << 1)
	Weed the headers?
#define	CH_DECODE   (1 << 2)
	Do RFC2047 header decoding.
#define	CH_XMIT   (1 << 3)
	Transmitting this message? (Ignore Lines: and Content-Length:)
#define	CH_FROM   (1 << 4)
	Retain the "From " message separator?
#define	CH_PREFIX   (1 << 5)
	Quote header using $indent_string string?
#define	CH_NOSTATUS   (1 << 6)
	Suppress the status and x-status fields.
#define	CH_REORDER   (1 << 7)
	Re-order output of headers (specified by 'header-order')
#define	CH_NONEWLINE   (1 << 8)
	Don't output terminating newline after the header.
#define	CH_MIME   (1 << 9)
	Ignore MIME fields.
#define	CH_UPDATE_LEN   (1 << 10)
	Update Lines: and Content-Length:
#define	CH_TXTPLAIN   (1 << 11)
	Generate text/plain MIME headers.
#define	CH_NOLEN   (1 << 12)
	Don't write Content-Length: and Lines:
#define	CH_WEED_DELIVERED   (1 << 13)
	Weed eventual Delivered-To headers.
#define	CH_FORCE_FROM   (1 << 14)
	Give CH_FROM precedence over CH_WEED?
#define	CH_NOQFROM   (1 << 15)
	Ignore ">From " line.
#define	CH_UPDATE_IRT   (1 << 16)
	Update In-Reply-To:
#define	CH_UPDATE_REFS   (1 << 17)
	Update References:
#define	CH_DISPLAY   (1 << 18)
	Display result to user.
#define	CH_UPDATE_LABEL   (1 << 19)
	Update X-Label: from email->env->x_label?
#define	CH_UPDATE_SUBJECT   (1 << 20)
	Update Subject: protected header update.
#define	CH_VIRTUAL   (1 << 21)
	Write virtual header lines too.

Typedefs
typedef uint16_t	CopyMessageFlags
	Flags for mutt_copy_message(), e.g. MUTT_CM_NOHEADER.
typedef uint32_t	CopyHeaderFlags
	Flags for mutt_copy_header(), e.g. CH_UPDATE.

Functions
int	mutt_copy_hdr (FILE *fp_in, FILE *fp_out, LOFF_T off_start, LOFF_T off_end, CopyHeaderFlags chflags, const char *prefix, int wraplen)
	Copy header from one file to another.
int	mutt_copy_header (FILE *fp_in, struct Email *e, FILE *fp_out, CopyHeaderFlags chflags, const char *prefix, int wraplen)
	Copy Email header.
int	mutt_copy_message_fp (FILE *fp_out, FILE *fp_in, struct Email *e, CopyMessageFlags cmflags, CopyHeaderFlags chflags, int wraplen)
	Make a copy of a message from a FILE pointer.
int	mutt_copy_message (FILE *fp_out, struct Email *e, struct Message *msg, CopyMessageFlags cmflags, CopyHeaderFlags chflags, int wraplen)
	Copy a message from a Mailbox.
int	mutt_append_message (struct Mailbox *m_dst, struct Mailbox *m_src, struct Email *e, struct Message *msg, CopyMessageFlags cmflags, CopyHeaderFlags chflags)
	Append a message.

Detailed Description

Duplicate the structure of an entire email.

Authors

• Michael R. Elkins
• Richard Russon
• Pietro Cerutti

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 copy_email.h.

Macro Definition Documentation

MUTT_CM_NO_FLAGS

#define MUTT_CM_NO_FLAGS   0

No flags are set.

Definition at line 37 of file copy_email.h.

MUTT_CM_NOHEADER

#define MUTT_CM_NOHEADER   (1 << 0)

Don't copy the message header.

Definition at line 38 of file copy_email.h.

MUTT_CM_PREFIX

#define MUTT_CM_PREFIX   (1 << 1)

Quote the header and body.

Definition at line 39 of file copy_email.h.

MUTT_CM_DECODE

#define MUTT_CM_DECODE   (1 << 2)

Decode the message body into text/plain.

Definition at line 40 of file copy_email.h.

MUTT_CM_DISPLAY

#define MUTT_CM_DISPLAY   (1 << 3)

Output is displayed to the user.

Definition at line 41 of file copy_email.h.

MUTT_CM_UPDATE

#define MUTT_CM_UPDATE   (1 << 4)

Update structs on sync.

Definition at line 42 of file copy_email.h.

MUTT_CM_WEED

#define MUTT_CM_WEED   (1 << 5)

Weed message/rfc822 attachment headers.

Definition at line 43 of file copy_email.h.

MUTT_CM_CHARCONV

#define MUTT_CM_CHARCONV   (1 << 6)

Perform character set conversions.

Definition at line 44 of file copy_email.h.

MUTT_CM_PRINTING

#define MUTT_CM_PRINTING   (1 << 7)

Printing the message - display light.

Definition at line 45 of file copy_email.h.

MUTT_CM_REPLYING

#define MUTT_CM_REPLYING   (1 << 8)

Replying the message.

Definition at line 46 of file copy_email.h.

MUTT_CM_DECODE_PGP

#define MUTT_CM_DECODE_PGP   (1 << 9)

Used for decoding PGP messages.

Definition at line 47 of file copy_email.h.

MUTT_CM_DECODE_SMIME

#define MUTT_CM_DECODE_SMIME   (1 << 10)

Used for decoding S/MIME messages.

Definition at line 48 of file copy_email.h.

MUTT_CM_VERIFY

#define MUTT_CM_VERIFY   (1 << 11)

Do signature verification.

Definition at line 49 of file copy_email.h.

MUTT_CM_DECODE_CRYPT

#define MUTT_CM_DECODE_CRYPT   (MUTT_CM_DECODE_PGP | MUTT_CM_DECODE_SMIME)

Combination flag for decoding any kind of cryptography (PGP or S/MIME)

Definition at line 52 of file copy_email.h.

CH_NO_FLAGS

#define CH_NO_FLAGS   0

No flags are set.

Definition at line 55 of file copy_email.h.

CH_UPDATE

#define CH_UPDATE   (1 << 0)

Update the status and x-status fields?

Definition at line 56 of file copy_email.h.

CH_WEED

#define CH_WEED   (1 << 1)

Weed the headers?

Definition at line 57 of file copy_email.h.

CH_DECODE

#define CH_DECODE   (1 << 2)

Do RFC2047 header decoding.

Definition at line 58 of file copy_email.h.

CH_XMIT

#define CH_XMIT   (1 << 3)

Transmitting this message? (Ignore Lines: and Content-Length:)

Definition at line 59 of file copy_email.h.

CH_FROM

#define CH_FROM   (1 << 4)

Retain the "From " message separator?

Definition at line 60 of file copy_email.h.

CH_PREFIX

#define CH_PREFIX   (1 << 5)

Quote header using $indent_string string?

Definition at line 61 of file copy_email.h.

CH_NOSTATUS

#define CH_NOSTATUS   (1 << 6)

Suppress the status and x-status fields.

Definition at line 62 of file copy_email.h.

CH_REORDER

#define CH_REORDER   (1 << 7)

Re-order output of headers (specified by 'header-order')

Definition at line 63 of file copy_email.h.

CH_NONEWLINE

#define CH_NONEWLINE   (1 << 8)

Don't output terminating newline after the header.

Definition at line 64 of file copy_email.h.

CH_MIME

#define CH_MIME   (1 << 9)

Ignore MIME fields.

Definition at line 65 of file copy_email.h.

CH_UPDATE_LEN

#define CH_UPDATE_LEN   (1 << 10)

Update Lines: and Content-Length:

Definition at line 66 of file copy_email.h.

CH_TXTPLAIN

#define CH_TXTPLAIN   (1 << 11)

Generate text/plain MIME headers.

Definition at line 67 of file copy_email.h.

CH_NOLEN

#define CH_NOLEN   (1 << 12)

Don't write Content-Length: and Lines:

Definition at line 68 of file copy_email.h.

CH_WEED_DELIVERED

#define CH_WEED_DELIVERED   (1 << 13)

Weed eventual Delivered-To headers.

Definition at line 69 of file copy_email.h.

CH_FORCE_FROM

#define CH_FORCE_FROM   (1 << 14)

Give CH_FROM precedence over CH_WEED?

Definition at line 70 of file copy_email.h.

CH_NOQFROM

#define CH_NOQFROM   (1 << 15)

Ignore ">From " line.

Definition at line 71 of file copy_email.h.

CH_UPDATE_IRT

#define CH_UPDATE_IRT   (1 << 16)

Update In-Reply-To:

Definition at line 72 of file copy_email.h.

CH_UPDATE_REFS

#define CH_UPDATE_REFS   (1 << 17)

Update References:

Definition at line 73 of file copy_email.h.

CH_DISPLAY

#define CH_DISPLAY   (1 << 18)

Display result to user.

Definition at line 74 of file copy_email.h.

CH_UPDATE_LABEL

#define CH_UPDATE_LABEL   (1 << 19)

Update X-Label: from email->env->x_label?

Definition at line 75 of file copy_email.h.

CH_UPDATE_SUBJECT

#define CH_UPDATE_SUBJECT   (1 << 20)

Update Subject: protected header update.

Definition at line 76 of file copy_email.h.

CH_VIRTUAL

#define CH_VIRTUAL   (1 << 21)

Write virtual header lines too.

Definition at line 77 of file copy_email.h.

Typedef Documentation

CopyMessageFlags

typedef uint16_t CopyMessageFlags

Flags for mutt_copy_message(), e.g. MUTT_CM_NOHEADER.

Definition at line 36 of file copy_email.h.

CopyHeaderFlags

typedef uint32_t CopyHeaderFlags

Flags for mutt_copy_header(), e.g. CH_UPDATE.

Definition at line 54 of file copy_email.h.

Function Documentation

mutt_copy_hdr()

int mutt_copy_hdr	(	FILE *	fp_in,
		FILE *	fp_out,
		LOFF_T	off_start,
		LOFF_T	off_end,
		CopyHeaderFlags	chflags,
		const char *	prefix,
		int	wraplen )

Copy header from one file to another.

Parameters

fp_in	FILE pointer to read from
fp_out	FILE pointer to write to
off_start	Offset to start from
off_end	Offset to finish at
chflags	Flags, see CopyHeaderFlags
prefix	Prefix for quoting headers
wraplen	Width to wrap at (when chflags & CH_DISPLAY)

Return values

0	Success
-1	Failure

Ok, the only reason for not merging this with mutt_copy_header() below is to avoid creating a Email structure in message_handler(). Also, this one will wrap headers much more aggressively than the other one.

Definition at line 112 of file copy_email.c.

{
  bool from = false;
  bool this_is_from = false;
  bool ignore = false;
  char buf[1024] = { 0 }; /* should be long enough to get most fields in one pass */
  char *nl = NULL;
  struct StringArray headers = ARRAY_HEAD_INITIALIZER;
  int hdr_count;
  int x;
  char *this_one = NULL;
  size_t this_one_len = 0;
 
  if (off_start < 0)
    return -1;
 
  if (ftello(fp_in) != off_start)
    if (!mutt_file_seek(fp_in, off_start, SEEK_SET))
      return -1;
 
  buf[0] = '\n';
  buf[1] = '\0';
 
  if ((chflags & (CH_REORDER | CH_WEED | CH_MIME | CH_DECODE | CH_PREFIX | CH_WEED_DELIVERED)) == 0)
  {
    /* Without these flags to complicate things
     * we can do a more efficient line to line copying */
    while (ftello(fp_in) < off_end)
    {
      nl = strchr(buf, '\n');
 
      if (!fgets(buf, sizeof(buf), fp_in))
        break;
 
      /* Convert CRLF line endings to LF */
      const size_t line_len = strlen(buf);
      if ((line_len > 2) && (buf[line_len - 2] == '\r') && (buf[line_len - 1] == '\n'))
      {
        buf[line_len - 2] = '\n';
        buf[line_len - 1] = '\0';
      }
 
      /* Is it the beginning of a header? */
      if (nl && (buf[0] != ' ') && (buf[0] != '\t'))
      {
        ignore = true;
        if (!from && mutt_str_startswith(buf, "From "))
        {
          if ((chflags & CH_FROM) == 0)
            continue;
          from = true;
        }
        else if ((chflags & CH_NOQFROM) && mutt_istr_startswith(buf, ">From "))
        {
          continue;
        }
        else if ((buf[0] == '\n') || ((buf[0] == '\r') && (buf[1] == '\n')))
        {
          break; /* end of header */
        }
 
        if ((chflags & (CH_UPDATE | CH_XMIT | CH_NOSTATUS)) &&
            (mutt_istr_startswith(buf, "Status:") || mutt_istr_startswith(buf, "X-Status:")))
        {
          continue;
        }
        if ((chflags & (CH_UPDATE_LEN | CH_XMIT | CH_NOLEN)) &&
            (mutt_istr_startswith(buf, "Content-Length:") ||
             mutt_istr_startswith(buf, "Lines:")))
        {
          continue;
        }
        if ((chflags & CH_UPDATE_REFS) && mutt_istr_startswith(buf, "References:"))
        {
          continue;
        }
        if ((chflags & CH_UPDATE_IRT) && mutt_istr_startswith(buf, "In-Reply-To:"))
        {
          continue;
        }
        if (chflags & CH_UPDATE_LABEL && mutt_istr_startswith(buf, "X-Label:"))
          continue;
        if ((chflags & CH_UPDATE_SUBJECT) && mutt_istr_startswith(buf, "Subject:"))
        {
          continue;
        }
 
        ignore = false;
      }
 
      if (!ignore && (fputs(buf, fp_out) == EOF))
        return -1;
    }
    return 0;
  }
 
  hdr_count = 1;
  x = 0;
 
  struct EmailModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(md);
 
  /* We are going to read and collect the headers in an array
   * so we are able to do re-ordering.
   * First count the number of entries in the array */
  if (chflags & CH_REORDER)
  {
    struct ListNode *np = NULL;
    STAILQ_FOREACH(np, &md->header_order, entries)
    {
      mutt_debug(LL_DEBUG3, "Reorder list: %s\n", np->data);
      hdr_count++;
    }
  }
 
  mutt_debug(LL_DEBUG1, "WEED is %sset\n", (chflags & CH_WEED) ? "" : "not ");
 
  ARRAY_RESERVE(&headers, hdr_count);
 
  /* Read all the headers into the array */
  while (ftello(fp_in) < off_end)
  {
    nl = strchr(buf, '\n');
 
    /* Read a line */
    if (!fgets(buf, sizeof(buf), fp_in))
      break;
 
    /* Is it the beginning of a header? */
    if (nl && (buf[0] != ' ') && (buf[0] != '\t'))
    {
      /* Do we have anything pending? */
      if (this_one)
      {
        if (chflags & CH_DECODE)
        {
          if (address_header_decode(&this_one) == 0)
            rfc2047_decode(&this_one);
          this_one_len = mutt_str_len(this_one);
        }
 
        add_one_header(&headers, x, this_one);
        this_one = NULL;
      }
 
      ignore = true;
      this_is_from = false;
      if (!from && mutt_str_startswith(buf, "From "))
      {
        if ((chflags & CH_FROM) == 0)
          continue;
        this_is_from = true;
        from = true;
      }
      else if ((buf[0] == '\n') || ((buf[0] == '\r') && (buf[1] == '\n')))
      {
        break; /* end of header */
      }
 
      /* note: CH_FROM takes precedence over header weeding. */
      if (!((chflags & CH_FROM) && (chflags & CH_FORCE_FROM) && this_is_from) &&
          (chflags & CH_WEED) && mutt_matches_ignore(buf))
      {
        continue;
      }
      if ((chflags & CH_WEED_DELIVERED) && mutt_istr_startswith(buf, "Delivered-To:"))
      {
        continue;
      }
      if ((chflags & (CH_UPDATE | CH_XMIT | CH_NOSTATUS)) &&
          (mutt_istr_startswith(buf, "Status:") || mutt_istr_startswith(buf, "X-Status:")))
      {
        continue;
      }
      if ((chflags & (CH_UPDATE_LEN | CH_XMIT | CH_NOLEN)) &&
          (mutt_istr_startswith(buf, "Content-Length:") || mutt_istr_startswith(buf, "Lines:")))
      {
        continue;
      }
      if ((chflags & CH_MIME))
      {
        if (mutt_istr_startswith(buf, "mime-version:"))
        {
          continue;
        }
        size_t plen = mutt_istr_startswith(buf, "content-");
        if ((plen != 0) && (mutt_istr_startswith(buf + plen, "transfer-encoding:") ||
                            mutt_istr_startswith(buf + plen, "type:")))
        {
          continue;
        }
      }
      if ((chflags & CH_UPDATE_REFS) && mutt_istr_startswith(buf, "References:"))
      {
        continue;
      }
      if ((chflags & CH_UPDATE_IRT) && mutt_istr_startswith(buf, "In-Reply-To:"))
      {
        continue;
      }
      if ((chflags & CH_UPDATE_LABEL) && mutt_istr_startswith(buf, "X-Label:"))
        continue;
      if ((chflags & CH_UPDATE_SUBJECT) && mutt_istr_startswith(buf, "Subject:"))
      {
        continue;
      }
 
      /* Find x -- the array entry where this header is to be saved */
      if (chflags & CH_REORDER)
      {
        struct ListNode *np = NULL;
        x = 0;
        int match = -1;
        size_t match_len = 0;
 
        STAILQ_FOREACH(np, &md->header_order, entries)
        {
          size_t hdr_order_len = mutt_str_len(np->data);
          if (mutt_istrn_equal(buf, np->data, hdr_order_len))
          {
            if ((match == -1) || (hdr_order_len > match_len))
            {
              match = x;
              match_len = hdr_order_len;
            }
            mutt_debug(LL_DEBUG2, "Reorder: %s matches %s\n", np->data, buf);
          }
          x++;
        }
        if (match != -1)
          x = match;
      }
 
      ignore = false;
    } /* If beginning of header */
 
    if (!ignore)
    {
      mutt_debug(LL_DEBUG2, "Reorder: x = %d; hdr_count = %d\n", x, hdr_count);
      if (this_one)
      {
        size_t blen = mutt_str_len(buf);
 
        MUTT_MEM_REALLOC(&this_one, this_one_len + blen + 1, char);
        mutt_strn_copy(this_one + this_one_len, buf, blen, blen + 1);
        this_one_len += blen;
      }
      else
      {
        this_one = mutt_str_dup(buf);
        this_one_len = mutt_str_len(this_one);
      }
    }
  } /* while (ftello (fp_in) < off_end) */
 
  /* Do we have anything pending?  -- XXX, same code as in above in the loop. */
  if (this_one)
  {
    if (chflags & CH_DECODE)
    {
      if (address_header_decode(&this_one) == 0)
        rfc2047_decode(&this_one);
      this_one_len = mutt_str_len(this_one);
    }
 
    add_one_header(&headers, x, this_one);
    this_one = NULL;
  }
 
  /* Now output the headers in order */
  bool error = false;
  const char **hp = NULL;
  const short c_wrap = cs_subset_number(NeoMutt->sub, "wrap");
 
  ARRAY_FOREACH(hp, &headers)
  {
    if (!error && hp && *hp)
    {
      /* We couldn't do the prefixing when reading because RFC2047
       * decoding may have concatenated lines.  */
      if (chflags & (CH_DECODE | CH_PREFIX))
      {
        const char *pre = (chflags & CH_PREFIX) ? prefix : NULL;
        wraplen = mutt_window_wrap_cols(wraplen, c_wrap);
 
        if (mutt_write_one_header(fp_out, 0, *hp, pre, wraplen, chflags, NeoMutt->sub) == -1)
        {
          error = true;
        }
      }
      else
      {
        if (fputs(*hp, fp_out) == EOF)
        {
          error = true;
        }
      }
    }
 
    FREE(hp);
  }
  ARRAY_FREE(&headers);
 
  if (error)
    return -1;
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_copy_header()

int mutt_copy_header	(	FILE *	fp_in,
		struct Email *	e,
		FILE *	fp_out,
		CopyHeaderFlags	chflags,
		const char *	prefix,
		int	wraplen )

Copy Email header.

Parameters

fp_in	FILE pointer to read from
e	Email
fp_out	FILE pointer to write to
chflags	See CopyHeaderFlags
prefix	Prefix for quoting headers (if CH_PREFIX is set)
wraplen	Width to wrap at (when chflags & CH_DISPLAY)

Return values

0	Success
-1	Failure

Definition at line 432 of file copy_email.c.

{
  char *temp_hdr = NULL;
  const bool c_weed = (chflags & CH_UPDATE) ? false : cs_subset_bool(NeoMutt->sub, "weed");
 
  if (e->env)
  {
    chflags |= ((e->env->changed & MUTT_ENV_CHANGED_IRT) ? CH_UPDATE_IRT : 0) |
               ((e->env->changed & MUTT_ENV_CHANGED_REFS) ? CH_UPDATE_REFS : 0) |
               ((e->env->changed & MUTT_ENV_CHANGED_XLABEL) ? CH_UPDATE_LABEL : 0) |
               ((e->env->changed & MUTT_ENV_CHANGED_SUBJECT) ? CH_UPDATE_SUBJECT : 0);
  }
 
  if (mutt_copy_hdr(fp_in, fp_out, e->offset, e->body->offset, chflags, prefix, wraplen) == -1)
    return -1;
 
  if (chflags & CH_TXTPLAIN)
  {
    char chsbuf[128] = { 0 };
    char buf[128] = { 0 };
    fputs("MIME-Version: 1.0\n", fp_out);
    fputs("Content-Transfer-Encoding: 8bit\n", fp_out);
    fputs("Content-Type: text/plain; charset=", fp_out);
    const char *const c_charset = cc_charset();
    mutt_ch_canonical_charset(chsbuf, sizeof(chsbuf), c_charset ? c_charset : "us-ascii");
    mutt_addr_cat(buf, sizeof(buf), chsbuf, MimeSpecials);
    fputs(buf, fp_out);
    fputc('\n', fp_out);
  }
 
  if ((chflags & CH_UPDATE_IRT) && !STAILQ_EMPTY(&e->env->in_reply_to) &&
      !(c_weed && mutt_matches_ignore("In-Reply-To")))
  {
    fputs("In-Reply-To:", fp_out);
    struct ListNode *np = NULL;
    STAILQ_FOREACH(np, &e->env->in_reply_to, entries)
    {
      fputc(' ', fp_out);
      fputs(np->data, fp_out);
    }
    fputc('\n', fp_out);
  }
 
  if ((chflags & CH_UPDATE_REFS) && !STAILQ_EMPTY(&e->env->references) &&
      !(c_weed && mutt_matches_ignore("References")))
  {
    fputs("References:", fp_out);
    mutt_write_references(&e->env->references, fp_out, 0);
    fputc('\n', fp_out);
  }
 
  if ((chflags & CH_UPDATE) && ((chflags & CH_NOSTATUS) == 0))
  {
    if ((e->old || e->read))
    {
      fputs("Status: ", fp_out);
      if (e->read)
        fputs("RO", fp_out);
      else if (e->old)
        fputc('O', fp_out);
      fputc('\n', fp_out);
    }
 
    if ((e->flagged || e->replied))
    {
      fputs("X-Status: ", fp_out);
      if (e->replied)
        fputc('A', fp_out);
      if (e->flagged)
        fputc('F', fp_out);
      fputc('\n', fp_out);
    }
  }
 
  if (chflags & CH_UPDATE_LEN && ((chflags & CH_NOLEN) == 0) &&
      !(c_weed && mutt_matches_ignore("Content-Length")))
  {
    fprintf(fp_out, "Content-Length: " OFF_T_FMT "\n", e->body->length);
    if ((e->lines != 0) || (e->body->length == 0))
      fprintf(fp_out, "Lines: %d\n", e->lines);
  }
 
#ifdef USE_NOTMUCH
  if (chflags & CH_VIRTUAL)
  {
    /* Add some fake headers based on notmuch data */
    char *folder = nm_email_get_folder(e);
    if (folder && !(c_weed && mutt_matches_ignore("Folder")))
    {
      struct Buffer *buf = buf_pool_get();
      buf_strcpy(buf, folder);
      pretty_mailbox(buf);
      fprintf(fp_out, "Folder: %s\n", buf->data);
      buf_pool_release(&buf);
    }
  }
#endif
 
  struct Buffer *tags = buf_pool_get();
  driver_tags_get(&e->tags, tags);
  if (!buf_is_empty(tags) && !(c_weed && mutt_matches_ignore("Tags")))
  {
    fputs("Tags: ", fp_out);
    fputs(buf_string(tags), fp_out);
    fputc('\n', fp_out);
  }
  buf_pool_release(&tags);
 
  const struct Slist *const c_send_charset = cs_subset_slist(NeoMutt->sub, "send_charset");
  const short c_wrap = cs_subset_number(NeoMutt->sub, "wrap");
  if ((chflags & CH_UPDATE_LABEL) && e->env->x_label &&
      !(c_weed && mutt_matches_ignore("X-Label")))
  {
    temp_hdr = e->env->x_label;
    /* env->x_label isn't currently stored with direct references elsewhere.
     * Mailbox->label_hash strdups the keys.  But to be safe, encode a copy */
    if (!(chflags & CH_DECODE))
    {
      temp_hdr = mutt_str_dup(temp_hdr);
      rfc2047_encode(&temp_hdr, NULL, sizeof("X-Label:"), c_send_charset);
    }
    if (mutt_write_one_header(fp_out, "X-Label", temp_hdr, (chflags & CH_PREFIX) ? prefix : 0,
                              mutt_window_wrap_cols(wraplen, c_wrap), chflags,
                              NeoMutt->sub) == -1)
    {
      return -1;
    }
    if (!(chflags & CH_DECODE))
      FREE(&temp_hdr);
  }
 
  if ((chflags & CH_UPDATE_SUBJECT) && e->env->subject &&
      !(c_weed && mutt_matches_ignore("Subject")))
  {
    temp_hdr = e->env->subject;
    /* env->subject is directly referenced in Mailbox->subj_hash, so we
     * have to be careful not to encode (and thus free) that memory. */
    if (!(chflags & CH_DECODE))
    {
      temp_hdr = mutt_str_dup(temp_hdr);
      rfc2047_encode(&temp_hdr, NULL, sizeof("Subject:"), c_send_charset);
    }
    if (mutt_write_one_header(fp_out, "Subject", temp_hdr, (chflags & CH_PREFIX) ? prefix : 0,
                              mutt_window_wrap_cols(wraplen, c_wrap), chflags,
                              NeoMutt->sub) == -1)
    {
      return -1;
    }
    if (!(chflags & CH_DECODE))
      FREE(&temp_hdr);
  }
 
  if ((chflags & CH_NONEWLINE) == 0)
  {
    if (chflags & CH_PREFIX)
      fputs(prefix, fp_out);
    fputc('\n', fp_out); /* add header terminator */
  }
 
  if (ferror(fp_out) || feof(fp_out))
    return -1;
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_copy_message_fp()

int mutt_copy_message_fp	(	FILE *	fp_out,
		FILE *	fp_in,
		struct Email *	e,
		CopyMessageFlags	cmflags,
		CopyHeaderFlags	chflags,
		int	wraplen )

Make a copy of a message from a FILE pointer.

Parameters

fp_out	Where to write output
fp_in	Where to get input
e	Email being copied
cmflags	Flags, see CopyMessageFlags
chflags	Flags, see CopyHeaderFlags
wraplen	Width to wrap at (when chflags & CH_DISPLAY)

Return values

0	Success
-1	Failure

Definition at line 663 of file copy_email.c.

{
  struct Body *body = e->body;
  struct Buffer *prefix = buf_pool_get();
  LOFF_T new_offset = -1;
  int rc = 0;
 
  if (cmflags & MUTT_CM_PREFIX)
  {
    const bool c_text_flowed = cs_subset_bool(NeoMutt->sub, "text_flowed");
    if (c_text_flowed)
    {
      buf_strcpy(prefix, ">");
    }
    else
    {
      const char *const c_attribution_locale = cs_subset_string(NeoMutt->sub, "attribution_locale");
      const struct Expando *c_indent_string = cs_subset_expando(NeoMutt->sub, "indent_string");
      struct Mailbox *m_cur = get_current_mailbox();
      setlocale(LC_TIME, NONULL(c_attribution_locale));
      mutt_make_string(prefix, -1, c_indent_string, m_cur, -1, e, MUTT_FORMAT_NO_FLAGS, NULL);
      setlocale(LC_TIME, "");
    }
  }
 
  if ((cmflags & MUTT_CM_NOHEADER) == 0)
  {
    if (cmflags & MUTT_CM_PREFIX)
    {
      chflags |= CH_PREFIX;
    }
    else if (e->attach_del && (chflags & CH_UPDATE_LEN))
    {
      int new_lines;
      int rc_attach_del = -1;
      LOFF_T new_length = body->length;
      struct Buffer *quoted_date = NULL;
 
      quoted_date = buf_pool_get();
      buf_addch(quoted_date, '"');
      mutt_date_make_date(quoted_date, cs_subset_bool(NeoMutt->sub, "local_date_header"));
      buf_addch(quoted_date, '"');
 
      /* Count the number of lines and bytes to be deleted */
      if (!mutt_file_seek(fp_in, body->offset, SEEK_SET))
      {
        goto attach_del_cleanup;
      }
      const int del = count_delete_lines(fp_in, body, &new_length, buf_len(quoted_date));
      if (del == -1)
      {
        goto attach_del_cleanup;
      }
      new_lines = e->lines - del;
 
      /* Copy the headers */
      if (mutt_copy_header(fp_in, e, fp_out, chflags | CH_NOLEN | CH_NONEWLINE, NULL, wraplen))
        goto attach_del_cleanup;
      fprintf(fp_out, "Content-Length: " OFF_T_FMT "\n", new_length);
      if (new_lines <= 0)
        new_lines = 0;
      else
        fprintf(fp_out, "Lines: %d\n", new_lines);
 
      putc('\n', fp_out);
      if (ferror(fp_out) || feof(fp_out))
        goto attach_del_cleanup;
      new_offset = ftello(fp_out);
 
      /* Copy the body */
      if (!mutt_file_seek(fp_in, body->offset, SEEK_SET))
        goto attach_del_cleanup;
      if (copy_delete_attach(body, fp_in, fp_out, buf_string(quoted_date)))
        goto attach_del_cleanup;
 
      buf_pool_release(&quoted_date);
 
      LOFF_T fail = ((ftello(fp_out) - new_offset) - new_length);
      if (fail)
      {
        mutt_error(ngettext("The length calculation was wrong by %ld byte",
                            "The length calculation was wrong by %ld bytes", fail),
                   (long) fail);
        new_length += fail;
      }
 
      /* Update original message if we are sync'ing a mailfolder */
      if (cmflags & MUTT_CM_UPDATE)
      {
        e->attach_del = false;
        e->lines = new_lines;
        body->offset = new_offset;
 
        body->length = new_length;
        mutt_body_free(&body->parts);
      }
 
      rc_attach_del = 0;
 
    attach_del_cleanup:
      buf_pool_release(&quoted_date);
      rc = rc_attach_del;
      goto done;
    }
 
    if (mutt_copy_header(fp_in, e, fp_out, chflags,
                         (chflags & CH_PREFIX) ? buf_string(prefix) : NULL, wraplen) == -1)
    {
      rc = -1;
      goto done;
    }
 
    new_offset = ftello(fp_out);
  }
 
  if (cmflags & MUTT_CM_DECODE)
  {
    /* now make a text/plain version of the message */
    struct State state = { 0 };
    state.fp_in = fp_in;
    state.fp_out = fp_out;
    if (cmflags & MUTT_CM_PREFIX)
      state.prefix = buf_string(prefix);
    if (cmflags & MUTT_CM_DISPLAY)
    {
      state.flags |= STATE_DISPLAY;
      state.wraplen = wraplen;
      const char *const c_pager = pager_get_pager(NeoMutt->sub);
      if (!c_pager)
        state.flags |= STATE_PAGER;
    }
    if (cmflags & MUTT_CM_PRINTING)
      state.flags |= STATE_PRINTING;
    if (cmflags & MUTT_CM_WEED)
      state.flags |= STATE_WEED;
    if (cmflags & MUTT_CM_CHARCONV)
      state.flags |= STATE_CHARCONV;
    if (cmflags & MUTT_CM_REPLYING)
      state.flags |= STATE_REPLYING;
 
    if ((WithCrypto != 0) && cmflags & MUTT_CM_VERIFY)
      state.flags |= STATE_VERIFY;
 
    rc = mutt_body_handler(body, &state);
  }
  else if ((WithCrypto != 0) && (cmflags & MUTT_CM_DECODE_CRYPT) && (e->security & SEC_ENCRYPT))
  {
    struct Body *cur = NULL;
    FILE *fp = NULL;
 
    if (((WithCrypto & APPLICATION_PGP) != 0) && (cmflags & MUTT_CM_DECODE_PGP) &&
        (e->security & APPLICATION_PGP) && (e->body->type == TYPE_MULTIPART))
    {
      if (crypt_pgp_decrypt_mime(fp_in, &fp, e->body, &cur))
      {
        rc = 1;
        goto done;
      }
      fputs("MIME-Version: 1.0\n", fp_out);
    }
 
    if (((WithCrypto & APPLICATION_SMIME) != 0) && (cmflags & MUTT_CM_DECODE_SMIME) &&
        (e->security & APPLICATION_SMIME) && (e->body->type == TYPE_APPLICATION))
    {
      if (crypt_smime_decrypt_mime(fp_in, &fp, e->body, &cur))
      {
        rc = 1;
        goto done;
      }
    }
 
    if (!cur)
    {
      mutt_error(_("No decryption engine available for message"));
      rc = 1;
      goto done;
    }
 
    mutt_write_mime_header(cur, fp_out, NeoMutt->sub);
    fputc('\n', fp_out);
 
    if (!mutt_file_seek(fp, cur->offset, SEEK_SET))
    {
      rc = 1;
      goto done;
    }
 
    if (mutt_file_copy_bytes(fp, fp_out, cur->length) == -1)
    {
      mutt_file_fclose(&fp);
      mutt_body_free(&cur);
      rc = 1;
      goto done;
    }
    mutt_body_free(&cur);
    mutt_file_fclose(&fp);
  }
  else
  {
    if (!mutt_file_seek(fp_in, body->offset, SEEK_SET))
    {
      rc = 1;
      goto done;
    }
    if (cmflags & MUTT_CM_PREFIX)
    {
      int c;
      size_t bytes = body->length;
 
      fputs(buf_string(prefix), fp_out);
 
      while (((c = fgetc(fp_in)) != EOF) && bytes--)
      {
        fputc(c, fp_out);
        if (c == '\n')
        {
          fputs(buf_string(prefix), fp_out);
        }
      }
    }
    else if (mutt_file_copy_bytes(fp_in, fp_out, body->length) == -1)
    {
      rc = 1;
      goto done;
    }
  }
 
  if ((cmflags & MUTT_CM_UPDATE) && ((cmflags & MUTT_CM_NOHEADER) == 0) &&
      (new_offset != -1))
  {
    body->offset = new_offset;
    mutt_body_free(&body->parts);
  }
 
done:
  buf_pool_release(&prefix);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_copy_message()

int mutt_copy_message	(	FILE *	fp_out,
		struct Email *	e,
		struct Message *	msg,
		CopyMessageFlags	cmflags,
		CopyHeaderFlags	chflags,
		int	wraplen )

Copy a message from a Mailbox.

Parameters

fp_out	FILE pointer to write to
e	Email
msg	Message
cmflags	Flags, see CopyMessageFlags
chflags	Flags, see CopyHeaderFlags
wraplen	Width to wrap at (when chflags & CH_DISPLAY)

Return values

0	Success
-1	Failure

should be made to return -1 on fatal errors, and 1 on non-fatal errors like partial decode, where it is worth displaying as much as possible

Definition at line 917 of file copy_email.c.

{
  if (!msg || !e->body)
  {
    return -1;
  }
  if (fp_out == msg->fp)
  {
    mutt_debug(LL_DEBUG1, "trying to read/write from/to the same FILE*!\n");
    return -1;
  }
 
  int rc = mutt_copy_message_fp(fp_out, msg->fp, e, cmflags, chflags, wraplen);
  if ((rc == 0) && (ferror(fp_out) || feof(fp_out)))
  {
    mutt_debug(LL_DEBUG1, "failed to detect EOF!\n");
    rc = -1;
  }
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_append_message()

int mutt_append_message	(	struct Mailbox *	m_dst,
		struct Mailbox *	m_src,
		struct Email *	e,
		struct Message *	msg,
		CopyMessageFlags	cmflags,
		CopyHeaderFlags	chflags )

Append a message.

Parameters

m_dst	Destination Mailbox
m_src	Source Mailbox
e	Email
msg	Message
cmflags	Flags, see CopyMessageFlags
chflags	Flags, see CopyHeaderFlags

Return values

0	Success
-1	Failure

Definition at line 992 of file copy_email.c.

{
  if (!e)
    return -1;
 
  const bool own_msg = !msg;
  if (own_msg && !(msg = mx_msg_open(m_src, e)))
  {
    return -1;
  }
 
  int rc = append_message(m_dst, msg->fp, m_src, e, cmflags, chflags);
  if (own_msg)
  {
    mx_msg_close(m_src, &msg);
  }
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: