KMime::Headers::ContentType

KMime::Headers::ContentType Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::ContentType:

Public Member Functions

QByteArray as7BitString (bool withHeaderType=true) const override
 
QByteArray boundary () const
 
contentCategory category () const
 
QByteArray charset () const
 
void clear () override
 
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 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
 
- Public Member Functions inherited from KMime::Headers::Generics::Parametrized
bool hasParameter (const QString &key) const
 
QString parameter (const QString &key) const
 
void setParameter (const QString &key, const QString &value)
 
- Public Member Functions inherited from KMime::Headers::Generics::Structured
QString asUnicodeString () const override
 
void from7BitString (const char *s, size_t len) override
 
void from7BitString (const QByteArray &s) override
 
void fromUnicodeString (const QString &s, const QByteArray &b) override
 
- Public Member Functions inherited from KMime::Headers::Base
 Base ()
 
virtual ~Base ()
 
bool is (const char *t) const
 
bool isMimeHeader () 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::Base
QByteArray typeIntro () const
 

Additional Inherited Members

- Public Types inherited from KMime::Headers::Base
typedef QVector< KMime::Headers::Base * > List
 

Detailed Description

Represents a "Content-Type" header.

See also
RFC 2045, section 5.

Definition at line 997 of file kmime_headers.h.

Member Function Documentation

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

Returns the encoded header.

Parameters
withHeaderTypeSpecifies whether the header-type should be included.

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

Definition at line 1689 of file kmime_headers.cpp.

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

Returns the boundary (for mulitpart containers).

Definition at line 1804 of file kmime_headers.cpp.

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

Returns the charset for the associated MIME entity.

Definition at line 1791 of file kmime_headers.cpp.

void KMime::Headers::ContentType::clear ( )
overridevirtual

Deletes.

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

Definition at line 1682 of file kmime_headers.cpp.

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

Returns the identifier of the associated MIME entity.

Definition at line 1822 of file kmime_headers.cpp.

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

Checks if this header contains any data.

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

Definition at line 1678 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 1775 of file kmime_headers.cpp.

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

Returns true if the associated MIME entity is an image.

Definition at line 1779 of file kmime_headers.cpp.

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

Tests if the media type equals mediatype.

Definition at line 1743 of file kmime_headers.cpp.

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

Tests if the mime type is mimeType.

Definition at line 1761 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 1783 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 1787 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 1771 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 1750 of file kmime_headers.cpp.

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

Returns true if the associated MIME entity is a text.

Definition at line 1767 of file kmime_headers.cpp.

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

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

Definition at line 1712 of file kmime_headers.cpp.

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

Returns the mimetype.

Definition at line 1707 of file kmime_headers.cpp.

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

Returns the name of the associated MIME entity.

Definition at line 1812 of file kmime_headers.cpp.

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
scursorPointer to the start of the data still to parse.
sendPointer to the end of the data.
isCRLFtrue if input string is terminated with a CRLF.

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

Definition at line 1862 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 1839 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 1830 of file kmime_headers.cpp.

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

Sets the mulitpart container boundary.

Definition at line 1808 of file kmime_headers.cpp.

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

Sets the charset.

Definition at line 1800 of file kmime_headers.cpp.

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

Sets the identifier.

Definition at line 1826 of file kmime_headers.cpp.

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

Sets the mimetype.

Parameters
mimeTypeThe new mimetype.

Definition at line 1732 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 1816 of file kmime_headers.cpp.

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

Sets parameters of a partial MIME entity.

Parameters
totalThe total number of entities in the multi-part set.
numberThe number of this entity in a multi-part set.

Definition at line 1857 of file kmime_headers.cpp.

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

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

Definition at line 1722 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Aug 7 2020 23:09:56 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.