• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KMIME Library

  • KMime
  • Headers
  • ContentType
Public Member Functions | Protected Member Functions | List of all members
KMime::Headers::ContentType Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::ContentType:
KMime::Headers::Generics::Parametrized KMime::Headers::Generics::Structured KMime::Headers::Base

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
 
- 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
 Structured (Content *p, const QByteArray &s)
 
 Structured (Content *p, const QString &s, const QByteArray &cs)
 
 Structured (Content *p=0)
 
virtual QString asUnicodeString () const
 
virtual void from7BitString (const QByteArray &s)
 
virtual void fromUnicodeString (const QString &s, const QByteArray &b)
 
- Public Member Functions inherited from KMime::Headers::Base
 Base (KMime::Content *parent=0)
 
virtual ~Base ()
 
QByteArray defaultCharset () const
 
bool forceDefaultCharset () const
 
bool is (const char *t) const
 
bool isMimeHeader () const
 
bool isXHeader () const
 
KMime::Content * parent () const
 
QByteArray rfc2047Charset () const
 
void setParent (KMime::Content *parent)
 
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)
 
- 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 1031 of file kmime_headers.h.

Member Function Documentation

◆ as7BitString()

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

Returns the encoded header.

Parameters
withHeaderTypeSpecifies whether the header-type should be included.

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

Definition at line 1724 of file kmime_headers.cpp.

◆ boundary()

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

Returns the boundary (for mulitpart containers).

Definition at line 1849 of file kmime_headers.cpp.

◆ category()

contentCategory KMime::Headers::ContentType::category ( ) const

Definition at line 1901 of file kmime_headers.cpp.

◆ charset()

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

Returns the charset for the associated MIME entity.

Definition at line 1834 of file kmime_headers.cpp.

◆ clear()

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

Deletes.

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

Definition at line 1716 of file kmime_headers.cpp.

◆ id()

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

Returns the identifier of the associated MIME entity.

Definition at line 1871 of file kmime_headers.cpp.

◆ isEmpty()

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

Checks if this header contains any data.

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

Definition at line 1711 of file kmime_headers.cpp.

◆ isHTMLText()

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

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

Definition at line 1814 of file kmime_headers.cpp.

◆ isImage()

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

Returns true if the associated MIME entity is an image.

Definition at line 1819 of file kmime_headers.cpp.

◆ isMediatype()

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

Tests if the media type equals mediatype.

Definition at line 1784 of file kmime_headers.cpp.

◆ isMultipart()

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

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

Definition at line 1824 of file kmime_headers.cpp.

◆ isPartial()

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

Returns true if the associated MIME entity contains partial data.

See also
partialNumber(), partialCount()

Definition at line 1829 of file kmime_headers.cpp.

◆ isPlainText()

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

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

Definition at line 1809 of file kmime_headers.cpp.

◆ isSubtype()

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

Tests if the mime sub-type equals subtype.

Definition at line 1792 of file kmime_headers.cpp.

◆ isText()

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

Returns true if the associated MIME entity is a text.

Definition at line 1804 of file kmime_headers.cpp.

◆ mediaType()

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

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

Definition at line 1749 of file kmime_headers.cpp.

◆ mimeType()

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

Returns the mimetype.

Definition at line 1743 of file kmime_headers.cpp.

◆ name()

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

Returns the name of the associated MIME entity.

Definition at line 1859 of file kmime_headers.cpp.

◆ parse()

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

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 1918 of file kmime_headers.cpp.

◆ partialCount()

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

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

See also
isPartial(), partialNumber()

Definition at line 1891 of file kmime_headers.cpp.

◆ partialNumber()

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

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

See also
isPartial(), partialCount()

Definition at line 1881 of file kmime_headers.cpp.

◆ setBoundary()

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

Sets the mulitpart container boundary.

Definition at line 1854 of file kmime_headers.cpp.

◆ setCategory()

void KMime::Headers::ContentType::setCategory ( contentCategory c)

Definition at line 1906 of file kmime_headers.cpp.

◆ setCharset()

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

Sets the charset.

Definition at line 1844 of file kmime_headers.cpp.

◆ setId()

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

Sets the identifier.

Definition at line 1876 of file kmime_headers.cpp.

◆ setMimeType()

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

Sets the mimetype and clears already existing parameters.

Parameters
mimeTypeThe new mimetype.

Definition at line 1771 of file kmime_headers.cpp.

◆ setName()

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

Sets the name to s using charset cs.

Definition at line 1864 of file kmime_headers.cpp.

◆ setPartialParams()

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 1912 of file kmime_headers.cpp.

◆ subType()

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

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

Definition at line 1760 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
  • kmime_headers.h
  • kmime_headers.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KMIME Library

Skip menu "KMIME Library"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal