KDE PIM / Developers / API Docs / libkmime

KMime::Codec Class Reference

Abstract base class of codecs like base64 and quoted-printable.Codecs for common mail transfer encodings. More...

#include <kmime_codecs.h>

Inherited by KMime::Base64Codec, KMime::IdentityCodec, KMime::QuotedPrintableCodec, KMime::Rfc2047QEncodingCodec, KMime::Rfc2231EncodingCodec, and KMime::UUCodec.

List of all members.

Public Member Functions

Static Public Member Functions

Static Protected Attributes


Detailed Description

Abstract base class of codecs like base64 and quoted-printable.Codecs for common mail transfer encodings.

It's a singleton.

Author:
Marc Mutz <mutz@kde.org>


Member Function Documentation

bool KMime::Codec::encode const char *&  scursor,
const char *const   send,
char *&  dcursor,
const char *const   dend,
bool  withCRLF = false
const [virtual]
 

Convenience wrapper that can be used for small chunks of data when you can provide a large enough buffer.

The default implementation creates an

See also:
Encoder and uses it.
Encodes a chunk of bytes starting at scursor and extending to send into the buffer described by dcursor and dend.

This function doesn't support chaining of blocks. The returned block cannot be added to, but you don't need to finalize it, too.

Example usage (in contains the input data):

 KMime::Codec * codec = KMime::Codec::codecForName( "base64" );
 kdFatal( !codec ) << "no base64 codec found!?" << endl;
 QByteArray out( in.size()*1.4 ); // crude maximal size of b64 encoding
 QByteArray::Iterator iit = in.begin();
 QByteArray::Iterator oit = out.begin();
 if ( !codec->encode( iit, in.end(), oit, out.end() ) ) {
   kdDebug() << "output buffer too small" << endl;
   return;
 }
 kdDebug() << "Size of encoded data: " << oit - out.begin() << endl;
 

Parameters:
scursor/send begin and end of input buffer
dcursor/dend begin and end of output buffer
withCRLF If true, make the lineends CRLF, else make them LF only.
Returns:
false if the encoded data didn't fit into the output buffer.

bool KMime::Codec::decode const char *&  scursor,
const char *const   send,
char *&  dcursor,
const char *const   dend,
bool  withCRLF = false
const [virtual]
 

Convenience wrapper that can be used for small chunks of data when you can provide a large enough buffer.

The default implementation creates a

See also:
Decoder and uses it.
Decodes a chunk of bytes starting at scursor and extending to send into the buffer described by dcursor and dend.

This function doesn't support chaining of blocks. The returned block cannot be added to, but you don't need to finalize it, too.

Example usage (in contains the input data):

 KMime::Codec * codec = KMime::Codec::codecForName( "base64" );
 kdFatal( !codec ) << "no base64 codec found!?" << endl;
 QByteArray out( in.size() ); // good guess for any encoding...
 QByteArray::Iterator iit = in.begin();
 QByteArray::Iterator oit = out.begin();
 if ( !codec->decode( iit, in.end(), oit, out.end() ) ) {
   kdDebug() << "output buffer too small" << endl;
   return;
 }
 kdDebug() << "Size of decoded data: " << oit - out.begin() << endl;
 

Parameters:
scursor/send begin and end of input buffer
dcursor/dend begin and end of output buffer
withCRLF If true, make the lineends CRLF, else make them LF only.
Returns:
false if the decoded data didn't fit into the output buffer.

QByteArray KMime::Codec::encode const QByteArray &  src,
bool  withCRLF = false
const [virtual]
 

Even more convenient, but also a bit slower and more memory intensive, since it allocates storage for the worst case and then shrinks the result QByteArray to the actual size again.

For use with small src.

QCString KMime::Codec::encodeToQCString const QByteArray &  src,
bool  withCRLF = false
const [virtual]
 

Even more convenient, but also a bit slower and more memory intensive, since it allocates storage for the worst case and then shrinks the result QCString to the actual size again.

For use with small src.

This method only works for codecs whose output is in the 8bit domain (ie. not in the binary domain). Codecs that do not fall into this category will return a null QCString.

QByteArray KMime::Codec::decode const QByteArray &  src,
bool  withCRLF = false
const [virtual]
 

Even more convenient, but also a bit slower and more memory intensive, since it allocates storage for the worst case and then shrinks the result QByteArray to the actual size again.

For use with small src.

virtual const char* KMime::Codec::name  )  const [pure virtual]
 

Returns:
the name of the encoding. Guaranteed to be lowercase.

The documentation for this class was generated from the following files: