KMime::Headers::Newsgroups

Search for usage in LXR

KMime::Headers::Newsgroups Class Reference

#include <headers.h>

Inheritance diagram for KMime::Headers::Newsgroups:

Public Member Functions

QByteArray as7BitString (bool withHeaderType=true) const override
 
QString asUnicodeString () const override
 
void fromUnicodeString (const QString &s) override
 
void fromUnicodeString (const QString &s, const QByteArray &b)
 
QList< QByteArraygroups () const
 
bool isCrossposted () const
 
bool isEmpty () const override
 
void setGroups (const QList< QByteArray > &groups)
 
- Public Member Functions inherited from KMime::Headers::Generics::Structured
QString asUnicodeString () const override
 
void from7BitString (QByteArrayView s) override
 
void fromUnicodeString (const QString &s) override
 
void fromUnicodeString (const QString &s, const QByteArray &b)
 
- Public Member Functions inherited from KMime::Headers::Base
 Base ()
 
virtual ~Base ()
 
void fromUnicodeString (const QString &s, const QByteArray &b)
 
bool is (QByteArrayView t) const
 
QByteArray rfc2047Charset () const
 
void setRFC2047Charset (const QByteArray &cs)
 
virtual const char * type () const
 

Protected Member Functions

bool parse (const char *&scursor, const char *const send, bool isCRLF=false) override
 
- Protected Member Functions inherited from KMime::Headers::Generics::Structured
- Protected Member Functions inherited from KMime::Headers::Base
QByteArray typeIntro () const
 

Additional Inherited Members

- Public Types inherited from KMime::Headers::Base
typedef QList< KMime::Headers::Base * > List
 

Detailed Description

Represents a "Newsgroups" header.

See also
RFC 1036, section 2.1.3.

Definition at line 1333 of file headers.h.

Member Function Documentation

◆ as7BitString()

QByteArray KMime::Headers::Newsgroups::as7BitString ( bool withHeaderType = true) const
nodiscardoverridevirtual

Returns the encoded header.

Parameters
withHeaderTypeSpecifies whether the header-type should be included.

Implements KMime::Headers::Base.

Definition at line 1386 of file headers.cpp.

◆ asUnicodeString()

QString KMime::Headers::Newsgroups::asUnicodeString ( ) const
nodiscardoverridevirtual

Returns the decoded content of the header without the header-type.

Note
The return value of this method should only be used when showing an address to the user. It is not guaranteed that fromUnicodeString( asUnicodeString(), ... ) will return the original string.

Implements KMime::Headers::Base.

Definition at line 1412 of file headers.cpp.

◆ fromUnicodeString() [1/2]

void KMime::Headers::Newsgroups::fromUnicodeString ( const QString & s)
overridevirtual

Parses the given Unicode representation of the header content.

Parameters
sThe header data as Unicode string.

Implements KMime::Headers::Base.

Definition at line 1406 of file headers.cpp.

◆ fromUnicodeString() [2/2]

void KMime::Headers::Base::fromUnicodeString ( const QString & s,
const QByteArray & b )
inline

Definition at line 144 of file headers.h.

◆ groups()

QList< QByteArray > KMime::Headers::Newsgroups::groups ( ) const
nodiscard

Returns the list of newsgroups.

Definition at line 1420 of file headers.cpp.

◆ isCrossposted()

bool KMime::Headers::Newsgroups::isCrossposted ( ) const
nodiscard

Returns true if this message has been cross-posted, i.e.

if it has been posted to multiple groups.

Definition at line 1427 of file headers.cpp.

◆ isEmpty()

bool KMime::Headers::Newsgroups::isEmpty ( ) const
nodiscardoverridevirtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 1416 of file headers.cpp.

◆ parse()

bool KMime::Headers::Newsgroups::parse ( const char *& scursor,
const char *const send,
bool isCRLF = false )
overrideprotectedvirtual

This method parses the raw header and needs to be implemented in every sub-class.

Parameters
scursorPointer to the start of the data still to parse.
sendPointer to the end of the data.
isCRLFtrue if input string is terminated with a CRLF.

Implements KMime::Headers::Generics::Structured.

Definition at line 1431 of file headers.cpp.

◆ setGroups()

void KMime::Headers::Newsgroups::setGroups ( const QList< QByteArray > & groups)

Sets the newsgroup list.

Definition at line 1422 of file headers.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:30:05 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.