MessageCore::AttachmentPart Class

class MessageCore::AttachmentPart

A class that encapsulates an attachment. More...

Header: #include <MessageCore/AttachmentPart>
CMake: find_package(KPim6MessageCore REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MessageCore)

Public Functions

AttachmentPart()
~AttachmentPart()
QByteArray charset() const
QByteArray data() const
QString description() const
KMime::Headers::contentEncoding encoding() const
QString fileName() const
bool isAutoEncoding() const
bool isCompressed() const
bool isEncrypted() const
bool isInline() const
bool isMessageOrMessageCollection() const
bool isSigned() const
QByteArray mimeType() const
QString name() const
void setAutoEncoding(bool enabled)
void setCharset(const QByteArray &charset)
void setCompressed(bool compressed)
void setData(const QByteArray &data)
void setDescription(const QString &description)
void setEncoding(KMime::Headers::contentEncoding encoding)
void setEncrypted(bool encrypted)
void setFileName(const QString &name)
void setInline(bool value)
void setMimeType(const QByteArray &mimeType)
void setName(const QString &name)
void setSigned(bool sign)
qint64 size() const

Detailed Description

Author: Constantin Berzan <exit3219@gmail.com>

Member Function Documentation

AttachmentPart::AttachmentPart()

Creates a new attachment part.

[noexcept] AttachmentPart::~AttachmentPart()

Destroys the attachment part.

QByteArray AttachmentPart::charset() const

Returns the charset that will be used for the attachment.

See also setCharset().

QByteArray AttachmentPart::data() const

Returns the payload data of the attachment.

See also setData().

QString AttachmentPart::description() const

Returns the description of the attachment.

See also setDescription().

KMime::Headers::contentEncoding AttachmentPart::encoding() const

Returns the encoding that will be used for the attachment.

See also setEncoding().

QString AttachmentPart::fileName() const

Returns the file name of the attachment.

See also setFileName().

bool AttachmentPart::isAutoEncoding() const

Returns whether encoding of the attachment will be determined automatically.

bool AttachmentPart::isCompressed() const

Returns whether the attachment is compressed.

bool AttachmentPart::isEncrypted() const

Returns whether the attachment is encrypted.

bool AttachmentPart::isInline() const

Returns whether the attachment will be displayed inline the message.

bool AttachmentPart::isMessageOrMessageCollection() const

Returns whether the specified attachment part is an encapsulated message (message/rfc822) or a collection of encapsulated messages (multipart/digest)

bool AttachmentPart::isSigned() const

Returns whether the attachment is signed.

QByteArray AttachmentPart::mimeType() const

Returns the mime type of the attachment.

See also setMimeType().

QString AttachmentPart::name() const

Returns the name of the attachment.

See also setName().

void AttachmentPart::setAutoEncoding(bool enabled)

Sets whether encoding of the attachment will be determined automatically.

See also isAutoEncoding().

void AttachmentPart::setCharset(const QByteArray &charset)

Sets the charset that will be used for the attachment.

See also charset().

void AttachmentPart::setCompressed(bool compressed)

Sets whether the attachment is compressed.

See also isCompressed().

void AttachmentPart::setData(const QByteArray &data)

Sets the payload data of the attachment.

See also data().

void AttachmentPart::setDescription(const QString &description)

Sets the description of the attachment.

See also description().

void AttachmentPart::setEncoding(KMime::Headers::contentEncoding encoding)

Sets the encoding that will be used for the attachment.

Note: only applies if isAutoEncoding is \ false

See also encoding().

void AttachmentPart::setEncrypted(bool encrypted)

Sets whether the attachment is encrypted.

See also isEncrypted().

void AttachmentPart::setFileName(const QString &name)

Sets the file name of the attachment.

The name will be used in the 'filename=' part of the Content-Disposition header.

See also fileName().

void AttachmentPart::setInline(bool value)

Sets whether the attachment will be displayed inline the message.

See also isInline().

void AttachmentPart::setMimeType(const QByteArray &mimeType)

Sets the mimeType of the attachment.

See also mimeType().

void AttachmentPart::setName(const QString &name)

Sets the name of the attachment.

The name will be used in the 'name=' part of the Content-Type header.

See also name().

void AttachmentPart::setSigned(bool sign)

Sets whether the attachment is signed.

See also isSigned().

qint64 AttachmentPart::size() const

Returns the size of the attachment.