KMime::Message Class Reference

#include <message.h>

Inheritance diagram for KMime::Message:

Public Types
typedef QSharedPointer< Message >	Ptr
Public Types inherited from KMime::Content
enum	DecodedTextTrimOption { NoTrim , TrimNewlines , TrimSpaces }
typedef QList< KMime::Content * >	List

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

Static Public Member Functions
static QString	mimeType ()

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() );
Headers::ContentTransferEncoding *cte = m->contentTransferEncoding();
cte->setEncoding(Headers::CE7Bit);
 
// Set the headers.
m->from()->fromUnicodeString("some@mailaddy.com");
m->to()->fromUnicodeString("someother@mailaddy.com");
m->cc()->fromUnicodeString("some@mailaddy.com");
m->date()->setDateTime(QDateTime::currentLocalDateTime());
m->subject()->fromUnicodeString("My Subject");
 
// 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->appendContent( b );
m->appendContent( a );
m->assemble();

Definition at line 64 of file message.h.

Member Typedef Documentation

Ptr

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

A shared pointer to a message object.

Definition at line 70 of file message.h.

Constructor & Destructor Documentation

Message()

KMime::Message::Message ( )

default

Creates an empty Message.

~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 22 of file message.cpp.

bcc() [1/2]

const KMime::Headers::Bcc * KMime::Message::bcc ( ) const

nodiscard

Returns the Bcc header.

Can be nullptr if the header doesn't exist.

Since

24.08

bcc() [2/2]

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() [1/2]

const KMime::Headers::Cc * KMime::Message::cc ( ) const

nodiscard

Returns the Cc header.

Can be nullptr if the header doesn't exist.

Since

24.08

cc() [2/2]

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() [1/2]

const KMime::Headers::Date * KMime::Message::date ( ) const

nodiscard

Returns the Date header.

Can be nullptr if the header doesn't exist.

Since

24.08

date() [2/2]

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() [1/2]

const KMime::Headers::From * KMime::Message::from ( ) const

nodiscard

Returns the From header.

Can be nullptr if the header doesn't exist.

Since

24.08

from() [2/2]

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() [1/2]

const KMime::Headers::InReplyTo * KMime::Message::inReplyTo ( ) const

nodiscard

Returns the In-Reply-To header.

Can be nullptr if the header doesn't exist.

Since

24.08

inReplyTo() [2/2]

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() [1/2]

Content * KMime::Message::mainBodyPart ( const QByteArray & type = QByteArray() )

nodiscard

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 36 of file message.cpp.

mainBodyPart() [2/2]

const Content * KMime::Message::mainBodyPart ( const QByteArray & type = QByteArray() ) const

nodiscard

Definition at line 42 of file message.cpp.

messageID() [1/2]

const KMime::Headers::MessageID * KMime::Message::messageID ( ) const

nodiscard

Returns the Message-ID header.

Can be nullptr if the header doesn't exist.

Since

24.08

messageID() [2/2]

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 ( )

staticnodiscard

Returns the MIME type used for Messages.

Definition at line 80 of file message.cpp.

organization() [1/2]

const KMime::Headers::Organization * KMime::Message::organization ( ) const

nodiscard

Returns the Organization header.

Can be nullptr if the header doesn't exist.

Since

24.08

organization() [2/2]

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() [1/2]

const KMime::Headers::References * KMime::Message::references ( ) const

nodiscard

Returns the References header.

Can be nullptr if the header doesn't exist.

Since

24.08

references() [2/2]

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() [1/2]

const KMime::Headers::ReplyTo * KMime::Message::replyTo ( ) const

nodiscard

Returns the Reply-To header.

Can be nullptr if the header doesn't exist.

Since

24.08

replyTo() [2/2]

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() [1/2]

const KMime::Headers::Sender * KMime::Message::sender ( ) const

nodiscard

Returns the Sender header.

Can be nullptr if the header doesn't exist.

Since

24.08

sender() [2/2]

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() [1/2]

const KMime::Headers::Subject * KMime::Message::subject ( ) const

nodiscard

Returns the Subject header.

Can be nullptr if the header doesn't exist.

Since

24.08

subject() [2/2]

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() [1/2]

const KMime::Headers::To * KMime::Message::to ( ) const

nodiscard

Returns the To header.

Can be nullptr if the header doesn't exist.

Since

24.08

to() [2/2]

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() [1/2]

const KMime::Headers::UserAgent * KMime::Message::userAgent ( ) const

nodiscard

Returns the User-Agent header.

Can be nullptr if the header doesn't exist.

Since

24.08

userAgent() [2/2]

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:

• message.h
• message.cpp