KMime::Message
#include <kmime_message.h>

Public Types | |
typedef QSharedPointer< Message > | Ptr |
![]() | |
typedef QVector< KMime::Content * > | List |
Static Public Member Functions | |
static QString | mimeType () |
![]() | |
static QByteArray | defaultCharset () |
Protected Member Functions | |
QByteArray | assembleHeaders () override |
Detailed Description
Represents a (email) message.
Sample how to create a multipart message:
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()
|
overridedefault |
Destroys this Message.
Member Function Documentation
◆ 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()
|
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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Fri Jun 9 2023 03:52:32 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.