VMime
vmime Namespace Reference

Namespaces

 charsets
 
 contentDispositionTypes
 
 dispositionActionModes
 
 dispositionModifiers
 
 dispositionSendingModes
 
 dispositionTypes
 
 encodingTypes
 
 exceptions
 
 fields
 
 lineLengthLimits
 
 mdn
 
 mediaTypes
 
 misc
 
 net
 
 security
 
 utility
 

Classes

class  address
 
class  addressList
 
class  attachment
 
class  attachmentHelper
 
class  body
 
class  bodyPart
 
class  charset
 
class  charsetConverter
 
class  charsetConverter_idna
 
class  charsetConverterOptions
 
class  component
 
class  contentDisposition
 
class  contentDispositionField
 
class  contentHandler
 
class  contentTypeField
 
class  context
 
class  datetime
 
class  defaultAttachment
 
class  disposition
 
class  emailAddress
 
class  emptyContentHandler
 
class  encoding
 
class  exception
 
class  fileAttachment
 
class  fileContentHandler
 
class  generationContext
 
class  header
 
class  headerField
 
class  headerFieldFactory
 
class  headerFieldValue
 
class  htmlTextPart
 
class  mailbox
 
class  mailboxGroup
 
class  mailboxList
 
class  mediaType
 
class  message
 
class  messageAttachment
 
class  messageBuilder
 
class  messageId
 
class  messageIdSequence
 
class  messageParser
 
class  noncopyable
 
class  object
 
class  parameter
 
class  parameterizedHeaderField
 
class  parserHelpers
 
class  parsingContext
 
class  path
 
class  plainTextPart
 
class  platform
 
class  propertySet
 
class  relay
 
class  streamContentHandler
 
class  stringContentHandler
 
class  text
 
class  textPart
 
class  textPartFactory
 
class  word
 
class  wordEncoder
 

Typedefs

typedef std::string string
 
typedef unsigned short port_t
 
typedef int char_t
 
typedef vmime_uint8 byte_t
 
typedef std::vector< byte_tbyteArray
 
typedef std::size_t size_t
 

Functions

const string libname ()
 
const string libversion ()
 
const string libapi ()
 
template<typename T , size_t N>
T const * cbegin (T const (&array)[N])
 
template<typename T , size_t N>
T const * cend (T const (&array)[N])
 
template<typename T , size_t N>
T * begin (T(&array)[N])
 
template<typename T , size_t N>
T * end (T(&array)[N])
 
template<typename T , size_t N>
size_t count (T const (&)[N])
 
template<class T1 , class T2 >
void copy_vector (const T1 &v1, T2 &v2)
 
template<class T >
shared_ptr< T > clone (shared_ptr< T > obj)
 
template<class T >
shared_ptr< T > clone (const T &obj)
 
template<class X , class Y >
shared_ptr< X > dynamicCast (shared_ptr< Y > obj)
 
template<class X , class Y >
shared_ptr< X > constCast (const shared_ptr< Y > &obj)
 

Variables

const string NULL_STRING
 
const text NULL_TEXT
 
const word NULL_WORD ("", vmime::charset(vmime::charsets::US_ASCII))
 
const string NEW_LINE_SEQUENCE = "\r\n "
 
const size_t NEW_LINE_SEQUENCE_LENGTH = 1
 
const string CRLF = "\r\n"
 
const string SUPPORTED_MIME_VERSION = "1.0"
 
const size_t npos = std::numeric_limits <size_t>::max()
 
CharsetEncodingEntry g_charsetEncodingMap []
 

Typedef Documentation

typedef vmime_uint8 byte_t
typedef std::vector<byte_t> byteArray
typedef int char_t
typedef unsigned short port_t
typedef std::size_t size_t
typedef std::string string

Function Documentation

T const* vmime::cbegin ( T const (&)  array[N])
T const* vmime::cend ( T const (&)  array[N])
shared_ptr<T> vmime::clone ( const T &  obj)

Clone helper (using a const reference).

This is an alias for dynamic_pointer_cast <T>(obj.clone()).

shared_ptr<X> vmime::constCast ( const shared_ptr< Y > &  obj)

Const cast helper.

shared_ptr<X> vmime::dynamicCast ( shared_ptr< Y >  obj)

Downcast helper.

Usage: vmime::dynamicCast <DerivedType>(obj), where 'obj' is of type Type, and DerivedType is derived from Type.

const string VMIME_EXPORT libapi ( )

Return the library API version (eg: "6:1:6").

Returns
library API version
const string VMIME_EXPORT libname ( )

Return the library name (eg: "libvmime").

Returns
library name
const string VMIME_EXPORT libversion ( )

Return the library version (eg: "0.5.2").

Returns
library version

Variable Documentation

VMIME_EXPORT const string CRLF = "\r\n"

The CR-LF sequence.

Referenced by bodyPart::generateImpl(), body::generateImpl(), and header::generateImpl().

CharsetEncodingEntry g_charsetEncodingMap[]
Initial value:
=
{
CharsetEncodingEntry("iso-8859", encodingTypes::QUOTED_PRINTABLE),
CharsetEncodingEntry("iso8859", encodingTypes::QUOTED_PRINTABLE),
CharsetEncodingEntry("iso-2022", encodingTypes::BASE64),
CharsetEncodingEntry("iso2022", encodingTypes::BASE64),
CharsetEncodingEntry("", "")
}
const char *const QUOTED_PRINTABLE
Definition: constants.cpp:80
const char *const BASE64
Definition: constants.cpp:79

Referenced by charset::getRecommendedEncoding().

VMIME_EXPORT const string NULL_STRING

"Null" (empty) string.

Referenced by headerFieldFactory::create().

VMIME_EXPORT const text NULL_TEXT

"Null" (empty) text.

VMIME_EXPORT const word NULL_WORD

"Null" (empty) word.

VMIME_EXPORT const string SUPPORTED_MIME_VERSION = "1.0"

The current MIME version supported by VMime.

Referenced by MDNHelper::buildMDN(), messageBuilder::construct(), and transport::processHeader().