summaryrefslogtreecommitdiff
path: root/kimap/rfccodecs.h
blob: 922189c18f6f638d07aa0b6ab9d4cc6aeeff1b21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/**********************************************************************
 *
 *   rfccodecs  - handler for various rfc/mime encodings
 *   Copyright (C) 2000 s.carstens@gmx.de
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Library General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public License
 *   along with this library; see the file COPYING.LIB.  If not, write to
 *   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *   Boston, MA 02110-1301, USA.
 *
 *********************************************************************/
/**
 * @file
 * This file is part of the IMAP support library and defines the
 * RfcCodecs class.
 *
 * @brief
 * Provides handlers for various RFC/MIME encodings.
 *
 * @author Sven Carstens
 */

#ifndef KIMAP_RFCCODECS_H
#define KIMAP_RFCCODECS_H

#include <QtCore/QString>

#include "kimap_export.h"

class QTextCodec;

namespace KIMAP {

  /**
    Converts an Unicode IMAP mailbox to a QByteArray which can be used in
    IMAP communication.
    @param src is the QByteArray containing the IMAP mailbox.
    @since 4.3
  */
  KIMAP_EXPORT QByteArray encodeImapFolderName( const QByteArray &src );

  /**
    Converts an UTF-7 encoded IMAP mailbox to a QByteArray
    @param inSrc is the QByteArray containing the Unicode path.
    @since 4.3
  */
  KIMAP_EXPORT QByteArray decodeImapFolderName( const QByteArray &inSrc );
  /**
    Converts an Unicode IMAP mailbox to a QString which can be used in
    IMAP communication.
    @param src is the QString containing the IMAP mailbox.
  */
  KIMAP_EXPORT QString encodeImapFolderName( const QString &src );

  /**
    Converts an UTF-7 encoded IMAP mailbox to a Unicode QString.
    @param inSrc is the QString containing the Unicode path.
  */
  KIMAP_EXPORT QString decodeImapFolderName( const QString &inSrc );

  /**
    Replaces " with \" and \ with \\ " and \ characters.
    @param src is the QString to quote.
  */
  KIMAP_EXPORT QString quoteIMAP( const QString &src );

  /**
    Replaces " with \" and \ with \\ " and \ characters.
    @param src is the QString to quote.
    @since 4.3
  */
  KIMAP_EXPORT QByteArray quoteIMAP( const QByteArray &src );

  /**
    Fetches a Codec by @p name.
    @param name is the QString version of the Codec name.
    @return Text Codec object
  */
  KIMAP_EXPORT QTextCodec *codecForName( const QString &name );

  /**
    Decodes a RFC2047 string @p str.
    @param str is the QString to decode.
    @param charset is the character set to use when decoding.
    @param language is the language found in the charset.
  */
  KIMAP_EXPORT const QString decodeRFC2047String( const QString &str,
                                                  QString &charset,
                                                  QString &language );
  /**
    Decodes a RFC2047 string @p str.
    @param str is the QString to decode.
    @param charset is the character set to use when decoding.
  */
  KIMAP_EXPORT const QString decodeRFC2047String( const QString &str,
                                                  QString &charset );

  /**
    Decodes a RFC2047 string @p str.
    @param str is the QString to decode.
  */
  KIMAP_EXPORT const QString decodeRFC2047String( const QString &str );

  /**
    Encodes a RFC2047 string @p str.
    @param str is the QString to encode.
  */
  KIMAP_EXPORT const QString encodeRFC2047String( const QString &str );

  /**
    Encodes a RFC2047 string @p str.
    @param str is the QString to encode.
  */
  KIMAP_EXPORT const QByteArray encodeRFC2047String( const QByteArray &str );

  /**
    Encodes a RFC2231 string @p str.
    @param str is the QString to encode.
  */
  KIMAP_EXPORT const QString encodeRFC2231String( const QString &str );

  /**
    Decodes a RFC2231 string @p str.
    @param str is the QString to decode.
  */
  KIMAP_EXPORT const QString decodeRFC2231String( const QString &str );
}

#endif