MIME-Version Header [MIME Headers]

MIME-Version header indicates what version of the protocol was used to construct the message. More...

Defines
#define	MSG_MIME_VERSION_INIT()
	Initializer for an msg_mime_version_t structure.
Typedefs
typedef msg_generic_t	msg_mime_version_t
	The structure msg_mime_version_t contains representation of an MIME-Version header.
Enumerations
enum	{ msg_mime_version_hash }
Functions
msg_mime_version_t *	msg_mime_version_init (msg_mime_version_t x[1])
	Initialize an msg_mime_version_t structure.
int	msg_is_mime_version (msg_header_t const *header)
	Test if header object is an instance of msg_mime_version_t.
msg_mime_version_t *	msg_mime_version_dup (su_home_t *home, msg_mime_version_t const *header)
	Duplicate (deep copy) msg_mime_version_t.
msg_mime_version_t *	msg_mime_version_copy (su_home_t *home, msg_mime_version_t const *header)
	Copy an msg_mime_version_t header structure.
msg_mime_version_t *	msg_mime_version_make (su_home_t *home, char const *s)
	Make a header structure msg_mime_version_t.
msg_mime_version_t *	msg_mime_version_format (su_home_t *home, char const *fmt,...)))
	Make a MIME-Version header from formatting result.
Variables
msg_parse_f	msg_mime_version_d
	Parse a MIME-Version header.
msg_print_f	msg_mime_version_e
	Print a MIME-Version header.
msg_hclass_t	msg_mime_version_class []
	Header class for MIME-Version header.

---

Detailed Description

MIME-Version header indicates what version of the protocol was used to construct the message.

Its syntax is defined in [H19.4.1, S20.24] as follows:

    MIME-Version   = "MIME-Version" ":" 1*DIGIT "." 1*DIGIT

---

Define Documentation

#define MSG_MIME_VERSION_INIT

(

)

Initializer for an msg_mime_version_t structure.

A static msg_mime_version_t structure must be initialized with the MSG_MIME_VERSION_INIT() macro. For instance,

  msg_mime_version_t msg_mime_version = MSG_MIME_VERSION_INIT;

---

Typedef Documentation

struct msg_generic_s msg_mime_version_t

The structure msg_mime_version_t contains representation of an MIME-Version header.

The msg_mime_version_t is defined as follows:

 typedef struct msg_generic_s
 {
   msg_common_t   g_common[1];    // Common fragment info
   msg_generic_t *g_next;           // Link to next header
   char const    *g_string;         // Header value
 } msg_mime_version_t;

---

Enumeration Type Documentation

anonymous enum

Enumerator:

msg_mime_version_hash

Hash of MIME-Version header.

---

Function Documentation

int msg_is_mime_version

(

msg_header_t const *

header

)

[inline]

Test if header object is an instance of msg_mime_version_t.

The function msg_is_mime_version() returns true (nonzero) if the header class is an instance of MIME-Version header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

The function msg_is_mime_version() returns true (nonzero) if the header object is an instance of header MIME-Version header and false (zero) otherwise.

msg_mime_version_t * msg_mime_version_copy	(	su_home_t *	home,
		msg_mime_version_t const *	header
	)			[inline]

Copy an msg_mime_version_t header structure.

The function msg_mime_version_copy() copies a header structure header. If the header structure header contains a reference (header->h_next) to a list of headers, all the headers in that list are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header structure header.

Parameters:

	home	memory home used to allocate new structure
	header	pointer to the header structure to be duplicated

When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old header, including the encoding of the old header, if present.

Example

   mime_version = msg_mime_version_copy(home, msg->msg_mime_version);

Returns:

The function msg_mime_version_copy() returns a pointer to newly copied header structure, or NULL upon an error.

msg_mime_version_t * msg_mime_version_dup	(	su_home_t *	home,
		msg_mime_version_t const *	header
	)			[inline]

Duplicate (deep copy) msg_mime_version_t.

The function msg_mime_version_dup() duplicates a header structure header. If the header structure header contains a reference (header->x_next) to a list of headers, all the headers in the list are duplicated, too.

Parameters:

	home	memory home used to allocate new structure
	header	header structure to be duplicated

When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.

Example

   mime_version = msg_mime_version_dup(home, msg->msg_mime_version);

Returns:

The function msg_mime_version_dup() returns a pointer to the newly duplicated msg_mime_version_t header structure, or NULL upon an error.

msg_mime_version_t * msg_mime_version_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a MIME-Version header from formatting result.

The function msg_mime_version_format() makes a new MIME-Version header object using snprintf-formatted result as its value. The function first prints the arguments according to the format fmt specified. Then it allocates a new header structure, and uses the formatting result as the header value.

Parameters:

	home	memory home used to allocate new header structure.
	fmt	string used as a printf()-style format
	...	argument list for format

Note:

This function may be implemented as a macro calling msg_header_format().

Returns:

The function msg_mime_version_format() returns a pointer to newly makes header structure, or NULL upon an error.

msg_mime_version_t* msg_mime_version_init

(

msg_mime_version_t

x[1]

)

[inline]

Initialize an msg_mime_version_t structure.

An msg_mime_version_t structure can be initialized with the msg_mime_version_init() function/macro. For instance,

  msg_mime_version_t msg_mime_version;

  msg_mime_version_init(&msg_mime_version);

Parameters:

x

pointer to msg_mime_version_t structure

msg_mime_version_t* msg_mime_version_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure msg_mime_version_t.

The function msg_mime_version_make() makes a new msg_mime_version_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters:

	home	memory home used to allocate new header structure.
	s	string to be decoded as value of the new header structure

Note:

This function may be implemented as a macro calling msg_header_make().

Returns:

The function msg_mime_version_make() returns a pointer to newly maked msg_mime_version_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t msg_mime_version_class[]

Header class for MIME-Version header.

The header class msg_mime_version_class defines how a MIME-Version header header is parsed and printed. It also contains methods used by message parser and other functions to manipulate the msg_mime_version_t header structure.