KMime::Message Class Reference

#include <kmime_message.h>

Inheritance diagram for KMime::Message:

Public Types
typedef QSharedPointer< Message >	Ptr
Public Types inherited from KMime::Content
typedef QVector< KMime::Content * >	List

Public Member Functions
	Message ()
	~Message () override
KMime::Headers::Bcc *	bcc (bool create=true)
KMime::Headers::Cc *	cc (bool create=true)
KMime::Headers::Date *	date (bool create=true)
KMime::Headers::From *	from (bool create=true)
KMime::Headers::InReplyTo *	inReplyTo (bool create=true)
Content *	mainBodyPart (const QByteArray &type=QByteArray())
KMime::Headers::MessageID *	messageID (bool create=true)
KMime::Headers::Organization *	organization (bool create=true)
KMime::Headers::References *	references (bool create=true)
KMime::Headers::ReplyTo *	replyTo (bool create=true)
KMime::Headers::Sender *	sender (bool create=true)
KMime::Headers::Subject *	subject (bool create=true)
KMime::Headers::To *	to (bool create=true)
KMime::Headers::UserAgent *	userAgent (bool create=true)
Public Member Functions inherited from KMime::Content
	Content (Content *parent=nullptr)
virtual	~Content ()
void	addContent (Content *content, bool prepend=false)
void	appendHeader (Headers::Base *h)
void	assemble ()
QVector< Content * >	attachments ()
QByteArray	body () const
QSharedPointer< Message >	bodyAsMessage () const
bool	bodyIsMessage () const
void	changeEncoding (Headers::contentEncoding e)
void	clear ()
void	clearContents (bool del=true)
Content *	content (const ContentIndex &index) const
Headers::ContentDescription *	contentDescription (bool create=true)
Headers::ContentDisposition *	contentDisposition (bool create=true)
Headers::ContentID *	contentID (bool create=true)
Headers::ContentLocation *	contentLocation (bool create=true)
QVector< Content * >	contents () const
Headers::ContentTransferEncoding *	contentTransferEncoding (bool create=true)
Headers::ContentType *	contentType (bool create=true)
QByteArray	decodedContent ()
QString	decodedText (bool trimText=false, bool removeTrailingNewlines=false)
QByteArray	encodedBody ()
QByteArray	encodedContent (bool useCrLf=false)
QByteArray	epilogue () const
void	fromUnicodeString (const QString &s)
bool	hasContent () const
bool	hasHeader (const char *type) const
QByteArray	head () const
template<typename T >
T *	header (bool create=false)
Headers::Base *	headerByType (const char *type) const
QVector< Headers::Base * >	headers () const
QVector< Headers::Base * >	headersByType (const char *type) const
ContentIndex	index () const
ContentIndex	indexForContent (Content *content) const
bool	isFrozen () const
bool	isTopLevel () const
int	lineCount () const
Content *	parent () const
void	parse ()
QByteArray	preamble () const
void	removeContent (Content *content, bool del=false)
template<typename T >
bool	removeHeader ()
bool	removeHeader (const char *type)
void	replaceContent (Content *oldContent, Content *newContent)
void	setBody (const QByteArray &body)
void	setContent (const QByteArray &s)
void	setEpilogue (const QByteArray &epilogue)
void	setFrozen (bool frozen=true)
void	setHead (const QByteArray &head)
void	setHeader (Headers::Base *h)
void	setParent (Content *parent)
void	setPreamble (const QByteArray &preamble)
int	size ()
int	storageSize () const
Content *	textContent ()
Content *	topLevel () const

Static Public Member Functions
static QString	mimeType ()
Static Public Member Functions inherited from KMime::Content
static QByteArray	defaultCharset ()

Protected Member Functions
QByteArray	assembleHeaders () override

Detailed Description

Represents a (email) message.

Sample how to create a multipart message:

// Set the multipart message.
Message *m = new Message;
Headers::ContentType *ct = m->contentType();
ct->setMimeType( "multipart/mixed" );
ct->setBoundary( multiPartBoundary() );
ct->setCategory( Headers::CCcontainer );
Headers::ContentTransferEncoding *cte = m->contentTransferEncoding();
cte->setEncoding(Headers::CE7Bit);
cte->setDecoded(true);
 
// Set the headers.
m->from()->fromUnicodeString( "[email protected]", "utf-8" );
m->to()->fromUnicodeString( "[email protected]", "utf-8" );
m->cc()->fromUnicodeString( "[email protected]", "utf-8" );
m->date()->setDateTime( QDateTime::currentLocalDateTime() );
m->subject()->fromUnicodeString( "My Subject", "utf-8" );
 
// Set the first multipart, the body message.
KMime::Content *b = new KMime::Content;
b->contentType()->setMimeType( "text/plain" );
b->setBody( "Some text..." );
 
// Set the second multipart, the attachment.
KMime::Content *a = new KMime::Content;
KMime::Headers::ContentDisposition *d = new KMime::Headers::ContentDisposition( attachMessage );
d->setFilename( "cal.ics" );
d->setDisposition( KMime::Headers::CDattachment );
a->contentType()->setMimeType( "text/plain" );
a->setHeader( d );
a->setBody( "Some text in the attachment..." );
 
// Attach the both multiparts and assemble the message.
m->addContent( b );
m->addContent( a );
m->assemble();

Definition at line 66 of file kmime_message.h.

Member Typedef Documentation

Ptr

typedef QSharedPointer<Message> KMime::Message::Ptr

A shared pointer to a message object.

Definition at line 72 of file kmime_message.h.

Constructor & Destructor Documentation

Message()

KMime::Message::Message

(

)

Creates an empty Message.

Definition at line 19 of file kmime_message.cpp.

~Message()

KMime::Message::~Message ( )

overridedefault

Destroys this Message.

Member Function Documentation

assembleHeaders()

QByteArray KMime::Message::assembleHeaders ( )

overrideprotectedvirtual

Reimplement this method if you need to assemble additional headers in a derived class.

Don't forget to call the implementation of the base class.

Returns

The raw, assembled headers.

Reimplemented from KMime::Content.

Reimplemented in KMime::NewsArticle.

Definition at line 25 of file kmime_message.cpp.

bcc()

KMime::Headers::Bcc* KMime::Message::bcc

(

bool

create = true

)

Returns the Bcc header.

Parameters

create

If true, create the header if it doesn't exist yet.

cc()

KMime::Headers::Cc* KMime::Message::cc

(

bool

create = true

)

Returns the Cc header.

Parameters

create

If true, create the header if it doesn't exist yet.

date()

KMime::Headers::Date* KMime::Message::date

(

bool

create = true

)

Returns the Date header.

Parameters

create

If true, create the header if it doesn't exist yet.

from()

KMime::Headers::From* KMime::Message::from

(

bool

create = true

)

Returns the From header.

Parameters

create

If true, create the header if it doesn't exist yet.

inReplyTo()

KMime::Headers::InReplyTo* KMime::Message::inReplyTo

(

bool

create = true

)

Returns the In-Reply-To header.

Parameters

create

If true, create the header if it doesn't exist yet.

mainBodyPart()

Content * KMime::Message::mainBodyPart

(

const QByteArray &

type = QByteArray()

)

Returns the first main body part of a given type, taking multipart/mixed and multipart/alternative nodes into consideration.

Eg. bodyPart("text/html") will return a html content object if that is provided in a multipart/alternative node, but not if it's the non-first child node of a multipart/mixed node (ie. an attachment).

Parameters

type	The mimetype of the body part, if not given, the first body part will be returned, regardless of it's type.

Definition at line 39 of file kmime_message.cpp.

messageID()

KMime::Headers::MessageID* KMime::Message::messageID

(

bool

create = true

)

Returns the Message-ID header.

Parameters

create

If true, create the header if it doesn't exist yet.

mimeType()

QString KMime::Message::mimeType ( )

static

Returns the MIME type used for Messages.

Definition at line 77 of file kmime_message.cpp.

organization()

KMime::Headers::Organization* KMime::Message::organization

(

bool

create = true

)

Returns the Organization header.

Parameters

create

If true, create the header if it doesn't exist yet.

references()

KMime::Headers::References* KMime::Message::references

(

bool

create = true

)

Returns the References header.

Parameters

create

If true, create the header if it doesn't exist yet.

replyTo()

KMime::Headers::ReplyTo* KMime::Message::replyTo

(

bool

create = true

)

Returns the Reply-To header.

Parameters

create

If true, create the header if it doesn't exist yet.

sender()

KMime::Headers::Sender* KMime::Message::sender

(

bool

create = true

)

Returns the Sender header.

Parameters

create

If true, create the header if it doesn't exist yet.

subject()

KMime::Headers::Subject* KMime::Message::subject

(

bool

create = true

)

Returns the Subject header.

Parameters

create

If true, create the header if it doesn't exist yet.

to()

KMime::Headers::To* KMime::Message::to

(

bool

create = true

)

Returns the To header.

Parameters

create

If true, create the header if it doesn't exist yet.

userAgent()

KMime::Headers::UserAgent* KMime::Message::userAgent

(

bool

create = true

)

Returns the User-Agent header.

Parameters

create

If true, create the header if it doesn't exist yet.

---

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

• kmime_message.h
• kmime_message.cpp