KMime::Headers::ContentType

#include <headers.h>

Inheritance diagram for KMime::Headers::ContentType:

[legend]

Public Member Functions
QByteArray	as7BitString (bool withHeaderType=true) const override

QByteArray	boundary () const

QByteArray	charset () const

QByteArray	id () const

bool	isEmpty () const override

bool	isHTMLText () const

bool	isImage () const

bool	isMediatype (const char *mediatype) const

bool	isMimeType (const char *mimeType) 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	setCharset (const QByteArray &s)

void	setId (const QByteArray &s)

void	setMimeType (const QByteArray &mimeType)

void	setName (const QString &s)

void	setName (const QString &s, const QByteArray &cs)

void	setPartialParams (int total, int number)

QByteArray	subType () const

Public Member Functions inherited from KMime::Headers::Generics::Parametrized
QByteArray	as7BitString (bool withHeaderType=true) const override

template<std::size_t N>
bool	hasParameter (const char(&key)[N]) const

bool	hasParameter (const QString &key) const

bool	hasParameter (QByteArrayView key) const

bool	hasParameter (QLatin1StringView key) const

bool	isEmpty () const override

template<std::size_t N>
QString	parameter (const char(&key)[N]) const

QString	parameter (const QString &key) const

QString	parameter (QByteArrayView key) const

QString	parameter (QLatin1StringView key) const

void	setParameter (const QByteArray &key, const QString &value)

void	setParameter (const QString &key, const QString &value)

Public Member Functions inherited from KMime::Headers::Generics::Structured
QString	asUnicodeString () const override

void	from7BitString (QByteArrayView s) override

void	fromUnicodeString (const QString &s) override

void	fromUnicodeString (const QString &s, const QByteArray &b)

Public Member Functions inherited from KMime::Headers::Base
	Base ()

virtual	~Base ()

void	fromUnicodeString (const QString &s, const QByteArray &b)

bool	is (QByteArrayView t) const

QByteArray	rfc2047Charset () const

void	setRFC2047Charset (const QByteArray &cs)

virtual const char *	type () const

Protected Member Functions
bool	parse (const char &scursor, const char const send, bool isCRLF=false) override

Protected Member Functions inherited from KMime::Headers::Generics::Parametrized
bool	parse (const char &scursor, const char const send, bool isCRLF=false) override

Protected Member Functions inherited from KMime::Headers::Base
QByteArray	typeIntro () const

Additional Inherited Members
Public Types inherited from KMime::Headers::Base
typedef QList< KMime::Headers::Base * >	List

Detailed Description

Represents a "Content-Type" header.

See also: RFC 2045, section 5.

Definition at line 988 of file headers.h.

Member Function Documentation

◆ as7BitString()

QByteArray KMime::Headers::ContentType::as7BitString ( bool withHeaderType = true ) const

nodiscardoverridevirtual

Returns the encoded header.

Parameters

withHeaderType Specifies whether the header-type should be included.

Implements KMime::Headers::Base.

Definition at line 1588 of file headers.cpp.

◆ boundary()

QByteArray KMime::Headers::ContentType::boundary ( ) const

nodiscard

Returns the boundary (for multipart containers).

Definition at line 1697 of file headers.cpp.

◆ charset()

QByteArray KMime::Headers::ContentType::charset ( ) const

nodiscard

Returns the charset for the associated MIME entity.

Definition at line 1684 of file headers.cpp.

◆ id()

QByteArray KMime::Headers::ContentType::id ( ) const

nodiscard

Returns the identifier of the associated MIME entity.

Definition at line 1714 of file headers.cpp.

◆ isEmpty()

bool KMime::Headers::ContentType::isEmpty ( ) const

nodiscardoverridevirtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 1584 of file headers.cpp.

◆ isHTMLText()

bool KMime::Headers::ContentType::isHTMLText ( ) const

nodiscard

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

Definition at line 1668 of file headers.cpp.

◆ isImage()

bool KMime::Headers::ContentType::isImage ( ) const

nodiscard

Returns true if the associated MIME entity is an image.

Definition at line 1672 of file headers.cpp.

◆ isMediatype()

bool KMime::Headers::ContentType::isMediatype ( const char * mediatype ) const

nodiscard

Tests if the media type equals mediatype.

Definition at line 1636 of file headers.cpp.

◆ isMimeType()

bool KMime::Headers::ContentType::isMimeType ( const char * mimeType ) const

nodiscard

Tests if the mime type is mimeType.

Definition at line 1654 of file headers.cpp.

◆ isMultipart()

bool KMime::Headers::ContentType::isMultipart ( ) const

nodiscard

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

Definition at line 1676 of file headers.cpp.

◆ isPartial()

bool KMime::Headers::ContentType::isPartial ( ) const

nodiscard

Returns true if the associated MIME entity contains partial data.

See also: partialNumber(), partialCount()

Definition at line 1680 of file headers.cpp.

◆ isPlainText()

bool KMime::Headers::ContentType::isPlainText ( ) const

nodiscard

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

Definition at line 1664 of file headers.cpp.

◆ isSubtype()

bool KMime::Headers::ContentType::isSubtype ( const char * subtype ) const

nodiscard

Tests if the mime sub-type equals subtype.

Definition at line 1643 of file headers.cpp.

◆ isText()

bool KMime::Headers::ContentType::isText ( ) const

nodiscard

Returns true if the associated MIME entity is a text.

Definition at line 1660 of file headers.cpp.

◆ mediaType()

QByteArray KMime::Headers::ContentType::mediaType ( ) const

nodiscard

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

Definition at line 1611 of file headers.cpp.

◆ mimeType()

QByteArray KMime::Headers::ContentType::mimeType ( ) const

nodiscard

Returns the mimetype.

Definition at line 1606 of file headers.cpp.

◆ name()

QString KMime::Headers::ContentType::name ( ) const

nodiscard

Returns the name of the associated MIME entity.

Definition at line 1705 of file headers.cpp.

◆ parse()

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

overrideprotectedvirtual

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.

Implements KMime::Headers::Generics::Structured.

Definition at line 1745 of file headers.cpp.

◆ partialCount()

int KMime::Headers::ContentType::partialCount ( ) const

nodiscard

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

See also: isPartial(), partialNumber()

Definition at line 1731 of file headers.cpp.

◆ partialNumber()

int KMime::Headers::ContentType::partialNumber ( ) const

nodiscard

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

See also: isPartial(), partialCount()

Definition at line 1722 of file headers.cpp.

◆ setBoundary()

void KMime::Headers::ContentType::setBoundary ( const QByteArray & s )

Sets the multipart container boundary.

Definition at line 1701 of file headers.cpp.

◆ setCharset()

void KMime::Headers::ContentType::setCharset ( const QByteArray & s )

Sets the charset.

Definition at line 1693 of file headers.cpp.

◆ setId()

void KMime::Headers::ContentType::setId ( const QByteArray & s )

Sets the identifier.

Definition at line 1718 of file headers.cpp.

◆ setMimeType()

void KMime::Headers::ContentType::setMimeType ( const QByteArray & mimeType )

Sets the mimetype.

Parameters

mimeType The new mimetype.

Definition at line 1631 of file headers.cpp.

◆ setName() [1/2]

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

Sets the name to s.

Definition at line 1709 of file headers.cpp.

◆ setName() [2/2]

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

inline

Definition at line 1095 of file headers.h.

◆ setPartialParams()

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 1740 of file headers.cpp.

◆ subType()

QByteArray KMime::Headers::ContentType::subType ( ) const

nodiscard

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

Definition at line 1621 of file headers.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KMime

KMime::Headers::ContentType

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ as7BitString()

◆ boundary()

◆ charset()

◆ id()

◆ isEmpty()

◆ isHTMLText()

◆ isImage()

◆ isMediatype()

◆ isMimeType()

◆ isMultipart()

◆ isPartial()

◆ isPlainText()

◆ isSubtype()

◆ isText()

◆ mediaType()

◆ mimeType()

◆ name()

◆ parse()

◆ partialCount()

◆ partialNumber()

◆ setBoundary()

◆ setCharset()

◆ setId()

◆ setMimeType()

◆ setName() [1/2]

◆ setName() [2/2]

◆ setPartialParams()

◆ subType()