KMime::Headers::Generics::SingleMailbox

Search for usage in LXR

KMime::Headers::Generics::SingleMailbox Class Reference

#include <headers.h>

Inheritance diagram for KMime::Headers::Generics::SingleMailbox:

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)
 
bool isEmpty () const override
 
Types::Mailbox mailbox () const
 
void setMailbox (const Types::Mailbox &mailbox)
 
- 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

Base class for headers that deal with exactly one mailbox (e.g.

Sender).

Definition at line 379 of file headers.h.

Member Function Documentation

◆ as7BitString()

QByteArray KMime::Headers::Generics::SingleMailbox::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 393 of file headers.cpp.

◆ asUnicodeString()

QString KMime::Headers::Generics::SingleMailbox::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 414 of file headers.cpp.

◆ fromUnicodeString() [1/2]

void KMime::Headers::Generics::SingleMailbox::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 408 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.

◆ isEmpty()

bool KMime::Headers::Generics::SingleMailbox::isEmpty ( ) const
nodiscardoverridevirtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 420 of file headers.cpp.

◆ mailbox()

Types::Mailbox KMime::Headers::Generics::SingleMailbox::mailbox ( ) const
nodiscard

Returns the mailbox in this header.

Since
25.04

Definition at line 426 of file headers.cpp.

◆ parse()

bool KMime::Headers::Generics::SingleMailbox::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 438 of file headers.cpp.

◆ setMailbox()

void KMime::Headers::Generics::SingleMailbox::setMailbox ( const Types::Mailbox & mailbox)

Sets the mailboxes in this header, replacing the current content.

Since
25.04

Definition at line 432 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 Sat Dec 21 2024 17:05:57 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.