mime.h File Reference

Constants and macros for managing MIME encoding. More...

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

Go to the source code of this file.

Macros
#define	MUTT_MIME_MAX_DEPTH   50
	Maximum nesting depth for MIME parts to prevent stack overflow.
#define	MUTT_MIME_MAX_PARTS   500
	Maximum number of MIME parts to process to prevent DoS.
#define	hexval(ch)
	Convert hexadecimal character to its integer value.
#define	is_multipart(body)
	Check if a body part is multipart or a message container.
#define	BODY_TYPE(body)
	Get the type name of a body part.
#define	ENCODING(x)
	Get the encoding name for an encoding type.

Enumerations
enum	ContentType {   TYPE_OTHER , TYPE_AUDIO , TYPE_APPLICATION , TYPE_IMAGE ,   TYPE_MESSAGE , TYPE_MODEL , TYPE_MULTIPART , TYPE_TEXT ,   TYPE_VIDEO , TYPE_ANY }
	Content-Type. More...
enum	ContentEncoding {   ENC_OTHER , ENC_7BIT , ENC_8BIT , ENC_QUOTED_PRINTABLE ,   ENC_BASE64 , ENC_BINARY , ENC_UUENCODED }
	Content-Transfer-Encoding. More...
enum	ContentDisposition { DISP_INLINE , DISP_ATTACH , DISP_FORM_DATA , DISP_NONE }
	Content-Disposition values. More...

Variables
const int	IndexHex [128]
	Lookup table for ASCII hex digits.
const char *const	BodyTypes []
	Common MIME body types.
const char *const	BodyEncodings []
	Common MIME body encodings.
const char	MimeSpecials []
	Characters that need special treatment in MIME.

Detailed Description

Constants and macros for managing MIME encoding.

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

Macro Definition Documentation

MUTT_MIME_MAX_DEPTH

#define MUTT_MIME_MAX_DEPTH   50

Maximum nesting depth for MIME parts to prevent stack overflow.

Definition at line 69 of file mime.h.

MUTT_MIME_MAX_PARTS

#define MUTT_MIME_MAX_PARTS   500

Maximum number of MIME parts to process to prevent DoS.

Definition at line 71 of file mime.h.

hexval

#define hexval

(

ch

)

Value:

IndexHex[(unsigned int) (ch)]

Convert hexadecimal character to its integer value.

Definition at line 81 of file mime.h.

is_multipart

#define is_multipart

(

body

)

Value:

(((body)->type == TYPE_MULTIPART) ||                                         \
 (((body)->type == TYPE_MESSAGE) && ((body)->subtype) &&                     \
  ((strcasecmp((body)->subtype, "rfc822") == 0) ||                           \
   (strcasecmp((body)->subtype, "news") == 0) ||                             \
   (strcasecmp((body)->subtype, "global") == 0))))

Check if a body part is multipart or a message container.

Definition at line 84 of file mime.h.

#define is_multipart(body)                                                     \
  (((body)->type == TYPE_MULTIPART) ||                                         \
   (((body)->type == TYPE_MESSAGE) && ((body)->subtype) &&                     \
    ((strcasecmp((body)->subtype, "rfc822") == 0) ||                           \
     (strcasecmp((body)->subtype, "news") == 0) ||                             \
     (strcasecmp((body)->subtype, "global") == 0))))

BODY_TYPE

#define BODY_TYPE

(

body

)

Value:

(((body)->type == TYPE_OTHER) && (body)->xtype ? (body)->xtype :             \
                                                 BodyTypes[((body)->type)])

Get the type name of a body part.

Definition at line 92 of file mime.h.

#define BODY_TYPE(body)                                                        \
  (((body)->type == TYPE_OTHER) && (body)->xtype ? (body)->xtype :             \
                                                   BodyTypes[((body)->type)])

ENCODING

#define ENCODING

(

x

)

Value:

BodyEncodings[(x)]

Get the encoding name for an encoding type.

Definition at line 97 of file mime.h.

Enumeration Type Documentation

ContentType

enum ContentType

Content-Type.

Enumerator
TYPE_OTHER	Unknown Content-Type.
TYPE_AUDIO	Type: 'audio/*'.
TYPE_APPLICATION	Type: 'application/*'.
TYPE_IMAGE	Type: 'image/*'.
TYPE_MESSAGE	Type: 'message/*'.
TYPE_MODEL	Type: 'model/*'.
TYPE_MULTIPART	Type: 'multipart/*'.
TYPE_TEXT	Type: 'text/*'.
TYPE_VIDEO	Type: 'video/*'.
TYPE_ANY	Type: '' or '.'.

Definition at line 29 of file mime.h.

{
  TYPE_OTHER,       
  TYPE_AUDIO,       
  TYPE_APPLICATION, 
  TYPE_IMAGE,       
  TYPE_MESSAGE,     
  TYPE_MODEL,       
  TYPE_MULTIPART,   
  TYPE_TEXT,        
  TYPE_VIDEO,       
  TYPE_ANY,         
};

ContentEncoding

enum ContentEncoding

Content-Transfer-Encoding.

Enumerator
ENC_OTHER	Encoding unknown.
ENC_7BIT	7-bit text
ENC_8BIT	8-bit text
ENC_QUOTED_PRINTABLE	Quoted-printable text.
ENC_BASE64	Base-64 encoded text.
ENC_BINARY	Binary.
ENC_UUENCODED	UUEncoded text.

Definition at line 46 of file mime.h.

{
  ENC_OTHER,            
  ENC_7BIT,             
  ENC_8BIT,             
  ENC_QUOTED_PRINTABLE, 
  ENC_BASE64,           
  ENC_BINARY,           
  ENC_UUENCODED,        
};

ContentDisposition

enum ContentDisposition

Content-Disposition values.

Enumerator
DISP_INLINE	Content is inline.
DISP_ATTACH	Content is attached.
DISP_FORM_DATA	Content is form-data.
DISP_NONE	No preferred disposition.

Definition at line 60 of file mime.h.

{
  DISP_INLINE,    
  DISP_ATTACH,    
  DISP_FORM_DATA, 
  DISP_NONE,      
};

Variable Documentation

IndexHex

const int IndexHex[128]

extern

Lookup table for ASCII hex digits.

Definition at line 35 of file mime.c.

                        {
  // clang-format off
  -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1,
  -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1,
  -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1,
   0, 1, 2, 3,  4, 5, 6, 7,  8, 9,-1,-1, -1,-1,-1,-1,
  -1,10,11,12, 13,14,15,-1, -1,-1,-1,-1, -1,-1,-1,-1,
  -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1,
  -1,10,11,12, 13,14,15,-1, -1,-1,-1,-1, -1,-1,-1,-1,
  -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1
  // clang-format on
};

BodyTypes

const char* const BodyTypes[]

extern

Common MIME body types.

Definition at line 51 of file mime.c.

                              {
  "x-unknown", "audio",     "application", "image", "message",
  "model",     "multipart", "text",        "video", "*",
};

BodyEncodings

const char* const BodyEncodings[]

extern

Common MIME body encodings.

Definition at line 59 of file mime.c.

                                  {
  "x-unknown", "7bit",   "8bit",        "quoted-printable",
  "base64",    "binary", "x-uuencoded",
};

MimeSpecials

const char MimeSpecials[]

extern

Characters that need special treatment in MIME.

Definition at line 69 of file mime.c.