body.h File Reference

Representation of the body of an email. More...

#include "config.h"
#include <stdbool.h>
#include <time.h>
#include "mutt/lib.h"
#include "parameter.h"

Include dependency graph for body.h:

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

Go to the source code of this file.

Data Structures
struct	Body
	The body of an email. More...

Enumerations
enum	ExpandoDataBody {   ED_BOD_ATTACH_COUNT = 1 , ED_BOD_ATTACH_QUALIFIES , ED_BOD_CHARSET_CONVERT , ED_BOD_DELETED ,   ED_BOD_DESCRIPTION , ED_BOD_DISPOSITION , ED_BOD_FILE , ED_BOD_FILE_DISPOSITION ,   ED_BOD_FILE_SIZE , ED_BOD_MIME_ENCODING , ED_BOD_MIME_MAJOR , ED_BOD_MIME_MINOR ,   ED_BOD_TAGGED , ED_BOD_UNLINK }
	Expando UIDs for Bodies. More...

Functions
	ARRAY_HEAD (BodyArray, struct Body *)
bool	mutt_body_cmp_strict (const struct Body *b1, const struct Body *b2)
	Strictly compare two email Body's.
void	mutt_body_free (struct Body **ptr)
	Free a Body.
char *	mutt_body_get_charset (struct Body *b, char *buf, size_t buflen)
	Get a body's character set.
struct Body *	mutt_body_new (void)
	Create a new Body.

Detailed Description

Representation of the body of 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 body.h.

Enumeration Type Documentation

ExpandoDataBody

enum ExpandoDataBody

Expando UIDs for Bodies.

See also

ED_BODY, ExpandoDomain

Enumerator
ED_BOD_ATTACH_COUNT	Body.attach_count.
ED_BOD_ATTACH_QUALIFIES	Body.attach_qualifies.
ED_BOD_CHARSET_CONVERT	Body.type.
ED_BOD_DELETED	Body.deleted.
ED_BOD_DESCRIPTION	Body.description.
ED_BOD_DISPOSITION	Body.disposition.
ED_BOD_FILE	Body.filename.
ED_BOD_FILE_DISPOSITION	Body.d_filename.
ED_BOD_FILE_SIZE	Body.filename.
ED_BOD_MIME_ENCODING	Body.encoding.
ED_BOD_MIME_MAJOR	Body.type, Body.xtype.
ED_BOD_MIME_MINOR	Body.subtype.
ED_BOD_TAGGED	Body.tagged.
ED_BOD_UNLINK	Body.unlink.

Definition at line 100 of file body.h.

{
  ED_BOD_ATTACH_COUNT = 1,     
  ED_BOD_ATTACH_QUALIFIES,     
  ED_BOD_CHARSET_CONVERT,      
  ED_BOD_DELETED,              
  ED_BOD_DESCRIPTION,          
  ED_BOD_DISPOSITION,          
  ED_BOD_FILE,                 
  ED_BOD_FILE_DISPOSITION,     
  ED_BOD_FILE_SIZE,            
  ED_BOD_MIME_ENCODING,        
  ED_BOD_MIME_MAJOR,           
  ED_BOD_MIME_MINOR,           
  ED_BOD_TAGGED,               
  ED_BOD_UNLINK,               
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	BodyArray	,
		struct Body *
	)

mutt_body_cmp_strict()

bool mutt_body_cmp_strict	(	const struct Body *	b1,
		const struct Body *	b2
	)

Strictly compare two email Body's.

Parameters

b1	First Body
b2	Second Body

Return values

true	Body's are strictly identical

Definition at line 110 of file body.c.

{
  if (!b1 || !b2)
    return false;
 
  if ((b1->type != b2->type) || (b1->encoding != b2->encoding) ||
      !mutt_str_equal(b1->subtype, b2->subtype) ||
      !mutt_str_equal(b1->description, b2->description) ||
      !mutt_param_cmp_strict(&b1->parameter, &b2->parameter) || (b1->length != b2->length))
  {
    return false;
  }
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_body_free()

void mutt_body_free

(

struct Body **

ptr

)

Free a Body.

Parameters

[out]

ptr

Body to free

Definition at line 58 of file body.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Body *a = *ptr, *b = NULL;
 
  while (a)
  {
    b = a;
    a = a->next;
 
    mutt_param_free(&b->parameter);
    if (b->filename)
    {
      if (b->unlink)
        unlink(b->filename);
      mutt_debug(LL_DEBUG1, "%sunlinking %s\n", b->unlink ? "" : "not ", b->filename);
    }
 
    FREE(&b->content_id);
    FREE(&b->filename);
    FREE(&b->d_filename);
    FREE(&b->charset);
    FREE(&b->content);
    FREE(&b->xtype);
    FREE(&b->subtype);
    FREE(&b->language);
    FREE(&b->description);
    FREE(&b->form_name);
 
    if (b->email)
    {
      /* Don't free twice (b->email->body = b->parts) */
      b->email->body = NULL;
      email_free(&b->email);
    }
 
    mutt_env_free(&b->mime_headers);
    mutt_body_free(&b->parts);
    FREE(&b);
  }
 
  *ptr = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_body_get_charset()

char * mutt_body_get_charset	(	struct Body *	b,
		char *	buf,
		size_t	buflen
	)

Get a body's character set.

Parameters

b	Body to examine
buf	Buffer for the result
buflen	Length of the buffer

Return values

ptr	Buffer containing character set
NULL	On error, or if not a text type

Definition at line 133 of file body.c.

{
  char *p = NULL;
 
  if (b && (b->type != TYPE_TEXT))
    return NULL;
 
  if (b)
    p = mutt_param_get(&b->parameter, "charset");
 
  if (p)
    mutt_ch_canonical_charset(buf, buflen, p);
  else
    mutt_str_copy(buf, "us-ascii", buflen);
 
  return buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_body_new()

struct Body * mutt_body_new

(

void

)

Create a new Body.

Return values

ptr	Newly allocated Body

Definition at line 44 of file body.c.

{
  struct Body *p = MUTT_MEM_CALLOC(1, struct Body);
 
  p->disposition = DISP_ATTACH;
  p->use_disp = true;
  TAILQ_INIT(&p->parameter);
  return p;
}

Here is the caller graph for this function: