KIMAP

rfccodecs.h
Go to the documentation of this file.
1/**********************************************************************
2 *
3 * rfccodecs - handler for various rfc/mime encodings
4 * SPDX-FileCopyrightText: 2000 s .carstens@gmx.de
5 *
6 * SPDX-License-Identifier: LGPL-2.0-or-later
7 *
8 *********************************************************************/
9/**
10 * @file
11 * This file is part of the IMAP support library and defines the
12 * RfcCodecs class.
13 *
14 * @brief
15 * Provides handlers for various RFC/MIME encodings.
16 *
17 * @author Sven Carstens
18 */
19
20#pragma once
21
22#include <QString>
23
24#include "kimap_export.h"
25
26namespace KIMAP
27{
28/**
29 Converts an Unicode IMAP mailbox to a QByteArray which can be used in
30 IMAP communication.
31 @param src is the QByteArray containing the IMAP mailbox.
32 @since 4.3
33*/
34[[nodiscard]] KIMAP_EXPORT QByteArray encodeImapFolderName(const QByteArray &src);
35
36/**
37 Converts an UTF-7 encoded IMAP mailbox to a QByteArray
38 @param inSrc is the QByteArray containing the Unicode path.
39 @since 4.3
40*/
41[[nodiscard]] KIMAP_EXPORT QByteArray decodeImapFolderName(const QByteArray &inSrc);
42/**
43 Converts an Unicode IMAP mailbox to a QString which can be used in
44 IMAP communication.
45 @param src is the QString containing the IMAP mailbox.
46*/
47[[nodiscard]] KIMAP_EXPORT QString encodeImapFolderName(const QString &src);
48
49/**
50 Converts an UTF-7 encoded IMAP mailbox to a Unicode QString.
51 @param inSrc is the QString containing the Unicode path.
52*/
53[[nodiscard]] KIMAP_EXPORT QString decodeImapFolderName(const QString &inSrc);
54
55/**
56 Replaces " with \" and \ with \\ " and \ characters.
57 @param src is the QString to quote.
58*/
59[[nodiscard]] KIMAP_EXPORT QString quoteIMAP(const QString &src);
60
61/**
62 Replaces " with \" and \ with \\ " and \ characters.
63 @param src is the QString to quote.
64 @since 4.3
65*/
66[[nodiscard]] KIMAP_EXPORT QByteArray quoteIMAP(const QByteArray &src);
67}
KIMAP_EXPORT QString quoteIMAP(const QString &src)
Replaces " with \" and \ with \\ " and \ characters.
KIMAP_EXPORT QByteArray decodeImapFolderName(const QByteArray &inSrc)
Converts an UTF-7 encoded IMAP mailbox to a QByteArray.
Definition rfccodecs.cpp:53
KIMAP_EXPORT QByteArray encodeImapFolderName(const QByteArray &src)
Converts an Unicode IMAP mailbox to a QByteArray which can be used in IMAP communication.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 14 2024 11:53:47 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.