NeoMutt  2024-04-25-85-g27bab4
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
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 Bodymutt_body_new (void)
 Create a new Body.
 

Detailed Description

Representation of the body of an email.

Authors
  • Richard Russon

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

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 99 of file body.h.

100{
115};
@ ED_BOD_DESCRIPTION
Body.description.
Definition: body.h:105
@ ED_BOD_CHARSET_CONVERT
Body.type.
Definition: body.h:103
@ ED_BOD_DELETED
Body.deleted.
Definition: body.h:104
@ ED_BOD_UNLINK
Body.unlink.
Definition: body.h:114
@ ED_BOD_FILE_SIZE
Body.filename.
Definition: body.h:109
@ ED_BOD_DISPOSITION
Body.disposition.
Definition: body.h:106
@ ED_BOD_ATTACH_QUALIFIES
Body.attach_qualifies.
Definition: body.h:102
@ ED_BOD_MIME_MAJOR
Body.type, Body.xtype.
Definition: body.h:111
@ ED_BOD_TAGGED
Body.tagged.
Definition: body.h:113
@ ED_BOD_ATTACH_COUNT
Body.attach_count.
Definition: body.h:101
@ ED_BOD_FILE
Body.filename.
Definition: body.h:107
@ ED_BOD_MIME_MINOR
Body.subtype.
Definition: body.h:112
@ ED_BOD_FILE_DISPOSITION
Body.d_filename.
Definition: body.h:108
@ ED_BOD_MIME_ENCODING
Body.encoding.
Definition: body.h:110

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
b1First Body
b2Second Body
Return values
trueBody's are strictly identical

Definition at line 109 of file body.c.

110{
111 if (!b1 || !b2)
112 return false;
113
114 if ((b1->type != b2->type) || (b1->encoding != b2->encoding) ||
115 !mutt_str_equal(b1->subtype, b2->subtype) ||
117 !mutt_param_cmp_strict(&b1->parameter, &b2->parameter) || (b1->length != b2->length))
118 {
119 return false;
120 }
121 return true;
122}
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
bool mutt_param_cmp_strict(const struct ParameterList *pl1, const struct ParameterList *pl2)
Strictly compare two ParameterLists.
Definition: parameter.c:166
LOFF_T length
length (in bytes) of attachment
Definition: body.h:53
struct ParameterList parameter
Parameters of the content-type.
Definition: body.h:62
char * description
content-description
Definition: body.h:55
char * subtype
content-type subtype
Definition: body.h:60
unsigned int encoding
content-transfer-encoding, ContentEncoding
Definition: body.h:41
unsigned int type
content-type primary type, ContentType
Definition: body.h:40
+ 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]ptrBody to free

Definition at line 58 of file body.c.

59{
60 if (!ptr || !*ptr)
61 return;
62
63 struct Body *a = *ptr, *b = NULL;
64
65 while (a)
66 {
67 b = a;
68 a = a->next;
69
70 mutt_param_free(&b->parameter);
71 if (b->filename)
72 {
73 if (b->unlink)
74 unlink(b->filename);
75 mutt_debug(LL_DEBUG1, "%sunlinking %s\n", b->unlink ? "" : "not ", b->filename);
76 }
77
78 FREE(&b->filename);
79 FREE(&b->d_filename);
80 FREE(&b->charset);
81 FREE(&b->content);
82 FREE(&b->xtype);
83 FREE(&b->subtype);
84 FREE(&b->language);
85 FREE(&b->description);
86 FREE(&b->form_name);
87
88 if (b->email)
89 {
90 /* Don't free twice (b->email->body = b->parts) */
91 b->email->body = NULL;
92 email_free(&b->email);
93 }
94
95 mutt_env_free(&b->mime_headers);
96 mutt_body_free(&b->parts);
97 FREE(&b);
98 }
99
100 *ptr = NULL;
101}
void mutt_body_free(struct Body **ptr)
Free a Body.
Definition: body.c:58
void email_free(struct Email **ptr)
Free an Email.
Definition: email.c:46
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:126
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
#define FREE(x)
Definition: memory.h:45
void mutt_param_free(struct ParameterList *pl)
Free a ParameterList.
Definition: parameter.c:62
The body of an email.
Definition: body.h:36
bool unlink
If true, filename should be unlink()ed before free()ing this structure.
Definition: body.h:67
struct Body * next
next attachment in the list
Definition: body.h:71
+ 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
bBody to examine
bufBuffer for the result
buflenLength of the buffer
Return values
ptrBuffer containing character set
NULLOn error, or if not a text type

Definition at line 132 of file body.c.

133{
134 char *p = NULL;
135
136 if (b && (b->type != TYPE_TEXT))
137 return NULL;
138
139 if (b)
140 p = mutt_param_get(&b->parameter, "charset");
141
142 if (p)
143 mutt_ch_canonical_charset(buf, buflen, p);
144 else
145 mutt_str_copy(buf, "us-ascii", buflen);
146
147 return buf;
148}
@ TYPE_TEXT
Type: 'text/*'.
Definition: mime.h:38
void mutt_ch_canonical_charset(char *buf, size_t buflen, const char *name)
Canonicalise the charset of a string.
Definition: charset.c:374
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:581
char * mutt_param_get(const struct ParameterList *pl, const char *s)
Find a matching Parameter.
Definition: parameter.c:85
+ 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
ptrNewly allocated Body

Definition at line 44 of file body.c.

45{
46 struct Body *p = mutt_mem_calloc(1, sizeof(struct Body));
47
49 p->use_disp = true;
51 return p;
52}
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
@ DISP_ATTACH
Content is attached.
Definition: mime.h:63
#define TAILQ_INIT(head)
Definition: queue.h:765
bool use_disp
Content-Disposition uses filename= ?
Definition: body.h:47
unsigned int disposition
content-disposition, ContentDisposition
Definition: body.h:42
+ Here is the call graph for this function:
+ Here is the caller graph for this function: