KMime::Headers::ContentType Class Reference

Represents a "Content-Type" header. More...

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::ContentType:

[legend]

List of all members.

Public Member Functions
virtual QByteArray	as7BitString (bool withHeaderType=true) const
QByteArray	boundary () const
contentCategory	category () const
QByteArray	charset () const
virtual void	clear ()
QByteArray	id () const
virtual bool	isEmpty () const
bool	isHTMLText () const
bool	isImage () const
bool	isMediatype (const char *mediatype) const
bool	isMultipart () const
bool	isPartial () const
bool	isPlainText () const
bool	isSubtype (const char *subtype) const
bool	isText () const
QByteArray	mediaType () const
QByteArray	mimeType () const
QString	name () const
int	partialCount () const
int	partialNumber () const
void	setBoundary (const QByteArray &s)
void	setCategory (contentCategory c)
void	setCharset (const QByteArray &s)
void	setId (const QByteArray &s)
void	setMimeType (const QByteArray &mimeType)
void	setName (const QString &s, const QByteArray &cs)
void	setPartialParams (int total, int number)
QByteArray	subType () const
Protected Member Functions
bool	parse (const char *&scursor, const char *const send, bool isCRLF=false)

---

Detailed Description

Represents a "Content-Type" header.

See also:

RFC 2045, section 5.

Definition at line 996 of file kmime_headers.h.

---

Member Function Documentation

QByteArray KMime::Headers::ContentType::as7BitString

(

bool

withHeaderType = true

)

const [virtual]

Returns the encoded header.

Parameters:

withHeaderType

Specifies whether the header-type should be included.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 1657 of file kmime_headers.cpp.

QByteArray KMime::Headers::ContentType::boundary

(

)

const

Returns the boundary (for mulitpart containers).

Definition at line 1768 of file kmime_headers.cpp.

QByteArray KMime::Headers::ContentType::charset

(

)

const

Returns the charset for the associated MIME entity.

Definition at line 1753 of file kmime_headers.cpp.

void KMime::Headers::ContentType::clear

(

)

[virtual]

Deletes.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 1648 of file kmime_headers.cpp.

QByteArray KMime::Headers::ContentType::id

(

)

const

Returns the identifier of the associated MIME entity.

Definition at line 1790 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isEmpty

(

)

const [virtual]

Checks if this header contains any data.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 1643 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isHTMLText

(

)

const

Returns true if the associated MIME entity is a HTML file.

Definition at line 1733 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isImage

(

)

const

Returns true if the associated MIME entity is an image.

Definition at line 1738 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isMediatype

(

const char *

mediatype

)

const

Tests if the media type equals mediatype.

Definition at line 1711 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isMultipart

(

)

const

Returns true if the associated MIME entity is a mulitpart container.

Definition at line 1743 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isPartial

(

)

const

Returns true if the associated MIME entity contains partial data.

See also:

partialNumber(), partialCount()

Definition at line 1748 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isPlainText

(

)

const

Returns true if the associated MIME entity is a plain text.

Definition at line 1727 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isSubtype

(

const char *

subtype

)

const

Tests if the mime sub-type equals subtype.

Definition at line 1716 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::isText

(

)

const

Returns true if the associated MIME entity is a text.

Definition at line 1721 of file kmime_headers.cpp.

QByteArray KMime::Headers::ContentType::mediaType

(

)

const

Returns the media type (first part of the mimetype).

Definition at line 1681 of file kmime_headers.cpp.

QByteArray KMime::Headers::ContentType::mimeType

(

)

const

Returns the mimetype.

Definition at line 1676 of file kmime_headers.cpp.

QString KMime::Headers::ContentType::name

(

)

const

Returns the name of the associated MIME entity.

Definition at line 1778 of file kmime_headers.cpp.

bool KMime::Headers::ContentType::parse	(	const char *&	scursor,
		const char *const	send,
		bool	isCRLF = false
	)			[protected, virtual]

This method parses the raw header and needs to be implemented in every sub-class.

Parameters:

	scursor	Pointer to the start of the data still to parse.
	send	Pointer to the end of the data.
	isCRLF	true if input string is terminated with a CRLF.

Reimplemented from KMime::Headers::Generics::Parametrized.

Definition at line 1837 of file kmime_headers.cpp.

int KMime::Headers::ContentType::partialCount

(

)

const

Returns the total number of parts in a multi-part set.

See also:

isPartial(), partialNumber()

Definition at line 1810 of file kmime_headers.cpp.

int KMime::Headers::ContentType::partialNumber

(

)

const

Returns the position of this part in a multi-part set.

See also:

isPartial(), partialCount()

Definition at line 1800 of file kmime_headers.cpp.

void KMime::Headers::ContentType::setBoundary

(

const QByteArray &

s

)

Sets the mulitpart container boundary.

Definition at line 1773 of file kmime_headers.cpp.

void KMime::Headers::ContentType::setCharset

(

const QByteArray &

s

)

Sets the charset.

Definition at line 1763 of file kmime_headers.cpp.

void KMime::Headers::ContentType::setId

(

const QByteArray &

s

)

Sets the identifier.

Definition at line 1795 of file kmime_headers.cpp.

void KMime::Headers::ContentType::setMimeType

(

const QByteArray &

mimeType

)

Sets the mimetype and clears already existing parameters.

Parameters:

mimeType

The new mimetype.

Definition at line 1691 of file kmime_headers.cpp.

void KMime::Headers::ContentType::setName	(	const QString &	s,
		const QByteArray &	cs
	)

Sets the name to s using charset cs.

Definition at line 1783 of file kmime_headers.cpp.

void KMime::Headers::ContentType::setPartialParams	(	int	total,
		int	number
	)

Sets parameters of a partial MIME entity.

Parameters:

	total	The total number of entities in the multi-part set.
	number	The number of this entity in a multi-part set.

Definition at line 1831 of file kmime_headers.cpp.

QByteArray KMime::Headers::ContentType::subType

(

)

const

Returns the mime sub-type (second part of the mimetype).

Definition at line 1686 of file kmime_headers.cpp.

---

The documentation for this class was generated from the following files:

• kmime_headers.h
• kmime_headers.cpp