KMime::NewsArticle Class Reference

#include <newsarticle.h>

Inheritance diagram for KMime::NewsArticle:

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

Public Member Functions
	NewsArticle ()
	~NewsArticle () override
const KMime::Headers::Control *	control () const
KMime::Headers::Control *	control (bool create=true)
const KMime::Headers::FollowUpTo *	followUpTo () const
KMime::Headers::FollowUpTo *	followUpTo (bool create=true)
const KMime::Headers::Lines *	lines () const
KMime::Headers::Lines *	lines (bool create=true)
const KMime::Headers::MailCopiesTo *	mailCopiesTo () const
KMime::Headers::MailCopiesTo *	mailCopiesTo (bool create=true)
const KMime::Headers::Newsgroups *	newsgroups () const
KMime::Headers::Newsgroups *	newsgroups (bool create=true)
const KMime::Headers::Supersedes *	supersedes () const
KMime::Headers::Supersedes *	supersedes (bool create=true)
Public Member Functions inherited from KMime::Message
	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

Protected Member Functions
QByteArray	assembleHeaders () override
Protected Member Functions inherited from KMime::Message
Protected Member Functions inherited from KMime::Content

Additional Inherited Members
Static Public Member Functions inherited from KMime::Message
static QString	mimeType ()

Detailed Description

NNTP news article.

Definition at line 21 of file newsarticle.h.

Member Typedef Documentation

Ptr

QSharedPointer<NewsArticle> KMime::NewsArticle::Ptr

A shared pointer to a news article.

Definition at line 27 of file newsarticle.h.

Constructor & Destructor Documentation

NewsArticle()

KMime::NewsArticle::NewsArticle ( )

default

Creates a NewsArticle object.

~NewsArticle()

KMime::NewsArticle::~NewsArticle ( )

overridedefault

Destroys this NewsArticle.

Member Function Documentation

assembleHeaders()

QByteArray KMime::NewsArticle::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::Message.

Definition at line 22 of file newsarticle.cpp.

control() [1/2]

const KMime::Headers::Control * KMime::NewsArticle::control ( ) const

nodiscard

Returns the Control header.

Can be nullptr if the header doesn't exist.

Since

24.08

control() [2/2]

KMime::Headers::Control * KMime::NewsArticle::control

(

bool

create = true

)

Returns the Control header.

Parameters

create

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

followUpTo() [1/2]

const KMime::Headers::FollowUpTo * KMime::NewsArticle::followUpTo ( ) const

nodiscard

Returns the Follow-Up-To header.

Can be nullptr if the header doesn't exist.

Since

24.08

followUpTo() [2/2]

KMime::Headers::FollowUpTo * KMime::NewsArticle::followUpTo

(

bool

create = true

)

Returns the Follow-Up-To header.

Parameters

create

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

lines() [1/2]

const KMime::Headers::Lines * KMime::NewsArticle::lines ( ) const

nodiscard

Returns the Lines header.

Can be nullptr if the header doesn't exist.

Since

24.08

lines() [2/2]

KMime::Headers::Lines * KMime::NewsArticle::lines

(

bool

create = true

)

Returns the Lines header.

Parameters

create

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

mailCopiesTo() [1/2]

const KMime::Headers::MailCopiesTo * KMime::NewsArticle::mailCopiesTo ( ) const

nodiscard

Returns the Mail-Copies-To header.

Can be nullptr if the header doesn't exist.

Since

24.08

mailCopiesTo() [2/2]

KMime::Headers::MailCopiesTo * KMime::NewsArticle::mailCopiesTo

(

bool

create = true

)

Returns the Mail-Copies-To header.

Parameters

create

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

newsgroups() [1/2]

const KMime::Headers::Newsgroups * KMime::NewsArticle::newsgroups ( ) const

nodiscard

Returns the Newsgroups header.

Can be nullptr if the header doesn't exist.

Since

24.08

newsgroups() [2/2]

KMime::Headers::Newsgroups * KMime::NewsArticle::newsgroups

(

bool

create = true

)

Returns the Newsgroups header.

Parameters

create

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

supersedes() [1/2]

const KMime::Headers::Supersedes * KMime::NewsArticle::supersedes ( ) const

nodiscard

Returns the Supersedes header.

Can be nullptr if the header doesn't exist.

Since

24.08

supersedes() [2/2]

KMime::Headers::Supersedes * KMime::NewsArticle::supersedes

(

bool

create = true

)

Returns the Supersedes 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:

• newsarticle.h
• newsarticle.cpp