• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.9.4 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:
Inheritance graph
[legend]

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=0)
 Structured (Content *p, const QByteArray &s)
 Structured (Content *p, const QString &s, const QByteArray &cs)
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)

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 1040 of file kmime_headers.h.

Member Function Documentation

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

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

Returns the boundary (for mulitpart containers).

Definition at line 1845 of file kmime_headers.cpp.

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

Returns the charset for the associated MIME entity.

Definition at line 1830 of file kmime_headers.cpp.

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

Deletes.

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

Definition at line 1717 of file kmime_headers.cpp.

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

Returns the identifier of the associated MIME entity.

Definition at line 1867 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 1712 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 1810 of file kmime_headers.cpp.

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

Returns true if the associated MIME entity is an image.

Definition at line 1815 of file kmime_headers.cpp.

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

Tests if the media type equals mediatype.

Definition at line 1783 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 1820 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 1825 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 1805 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 1790 of file kmime_headers.cpp.

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

Returns true if the associated MIME entity is a text.

Definition at line 1800 of file kmime_headers.cpp.

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

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

Definition at line 1750 of file kmime_headers.cpp.

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

Returns the mimetype.

Definition at line 1744 of file kmime_headers.cpp.

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

Returns the name of the associated MIME entity.

Definition at line 1855 of file kmime_headers.cpp.

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 1914 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 1887 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 1877 of file kmime_headers.cpp.

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

Sets the mulitpart container boundary.

Definition at line 1850 of file kmime_headers.cpp.

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

Sets the charset.

Definition at line 1840 of file kmime_headers.cpp.

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

Sets the identifier.

Definition at line 1872 of file kmime_headers.cpp.

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

Sets the mimetype and clears already existing parameters.

Parameters
mimeTypeThe new mimetype.

Definition at line 1770 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 1860 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 1908 of file kmime_headers.cpp.

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-2012 The KDE developers.
Generated on Tue Dec 11 2012 12:13:08 by doxygen 1.8.1.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KMIME Library

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

kdepimlibs-4.9.4 API Reference

Skip menu "kdepimlibs-4.9.4 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • 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