vmime Namespace Reference

Namespaces
namespace	charsets
namespace	contentDispositionTypes
namespace	dispositionActionModes
namespace	dispositionModifiers
namespace	dispositionSendingModes
namespace	dispositionTypes
namespace	encodingTypes
namespace	exceptions
namespace	fields
namespace	lineLengthLimits
namespace	mdn
namespace	mediaTypes
namespace	misc
namespace	net
namespace	platforms
namespace	security
namespace	utility
Classes
class	address
	Abstract class representing a mailbox or a group of mailboxes. More...
class	addressList
	A list of addresses. More...
class	attachment
	Base class for all types of attachment. More...
class	attachmentHelper
	Retrieve attachment information from message parts. More...
class	body
	Body section of a MIME part. More...
class	bodyPart
	A MIME part. More...
class	bodyPartFactory
class	charset
	Charset description (basic type). More...
class	charsetConverter
	Convert between charsets. More...
class	component
	This abstract class is the base for all the classes in the library. More...
class	contentDisposition
	Content disposition (basic type). More...
class	contentDispositionField
class	contentHandler
class	contentTypeField
class	datetime
	Date and time (basic type). More...
class	defaultAttachment
	Default implementation for attachments. More...
class	disposition
	Disposition - from RFC-3798 (basic type). More...
class	emptyContentHandler
class	encoding
	Content encoding (basic type). More...
class	exception
	Base class for VMime exceptions. More...
class	fileAttachment
	Attachment of type 'file'. More...
class	header
	Header section of a MIME part. More...
class	headerField
	Base class for header fields. More...
class	headerFieldFactory
	Creates header field and header field value objects. More...
class	headerFieldValue
	Base class for all classes that can be used as a value for a header field. More...
class	htmlTextPart
	Text part of type 'text/html'. More...
class	mailbox
	A mailbox: full name + email (basic type). More...
class	mailboxGroup
	A group of mailboxes (basic type). More...
class	mailboxList
	A list of mailboxes (basic type). More...
class	mediaType
	Content media type (basic type). More...
class	message
	A MIME message. More...
class	messageAttachment
	Attachment of type message/rfc822. More...
class	messageBuilder
	A helper for building MIME messages. More...
class	messageId
	Message identifier (basic type). More...
class	messageIdSequence
	A list of message identifiers (basic type). More...
class	messageParser
	A helper for parsing MIME messages. More...
class	object
	Base object for all objects in the library. More...
class	options
	A class to set global options for VMime. More...
class	parameter
class	parameterizedHeaderField
	A header field that can also contain parameters (name=value pairs). More...
class	parserHelpers
class	path
	A path: a local part + '@' + a domain. More...
class	plainTextPart
	Text part of type 'text/plain'. More...
class	platform
	Allow setting or getting the current platform handler. More...
class	propertySet
	Manage a list of (name,value) pairs. More...
class	relay
	Trace information about a relay (basic type). More...
class	streamContentHandler
class	stringContentHandler
class	text
	List of encoded-words, as defined in RFC-2047 (basic type). More...
class	textPart
	Generic text part. More...
class	textPartFactory
class	word
	A class that encapsulates an encoded-word (RFC-2047): some text encoded into one specified charset. More...
class	wordEncoder
	Encodes words following RFC-2047. More...
Typedefs
typedef platform	platformDependant
typedef std::string	string
typedef unsigned short	port_t
typedef int	char_t
typedef vmime_uint8	byte_t
typedef std::vector< byte_t >	byteArray
Functions
const string	libname ()
const string	libversion ()
const string	libapi ()
template<typename T , size_t N>
T const *	begin (T const (&array)[N])
template<typename T , size_t N>
T const *	end (T const (&array)[N])
template<typename T , size_t N>
size_t	count (T const (&array)[N])
template<class T1 , class T2 >
void	copy_vector (const T1 &v1, T2 &v2)
template<class T >
ref< T >	clone (ref< const T > x)
template<class T >
ref< T >	clone (const T &x)
template<class X , class Y >
ref< X >	dynamicCast (ref< Y > y)
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 string::size_type	NEW_LINE_SEQUENCE_LENGTH = 1
const string	CRLF = "\r\n"
const string	SUPPORTED_MIME_VERSION = "1.0"
const null_ref	null = null_ref()

---

Typedef Documentation

typedef vmime_uint8 byte_t

typedef std::vector<byte_t> byteArray

typedef int char_t

typedef platform platformDependant

Compatibility with older versions of VMime (before 0.8.1).

typedef unsigned short port_t

typedef std::string string

---

Function Documentation

T const* vmime::begin

(

T const (&)

array[N]

)

Referenced by datetime::parse().

ref<T> vmime::clone

(

const T &

x

)

Clone helper.

Use "vmime::clone(obj)" instead of "obj.clone().cast <objtype>()".

ref<T> vmime::clone

(

ref< const T >

x

)

Clone helper.

Use "vmime::clone(obj)" instead of "obj->clone().cast <objtype>()".

void vmime::copy_vector	(	const T1 &	v1,
		T2 &	v2
	)

References count().

Referenced by text::decodeAndUnfold(), text::getChildComponents(), messageIdSequence::getChildComponents(), mailboxGroup::getChildComponents(), header::getChildComponents(), and text::parse().

size_t vmime::count

(

T const (&)

array[N]

)

Referenced by copy_vector(), stringUtils::countASCIIchars(), posixChildProcessFactory::create(), text::createFromString(), encoding::decide(), uuEncoder::decode(), b64Encoder::decode(), b64Encoder::encode(), relay::generate(), component::getChildComponents(), and stopSequenceFilteredInputStream< COUNT >::read().

ref<X> vmime::dynamicCast

(

ref< Y >

y

)

Downcast helper.

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

T const* vmime::end

(

T const (&)

array[N]

)

Referenced by text::createFromString(), parameterizedHeaderField::findParameter(), header::getField(), parameterizedHeaderField::getParameter(), parameterizedHeaderField::hasParameter(), stringUtils::isStringEqualNoCase(), datetime::parse(), stopSequenceFilteredInputStream< COUNT >::read(), dotFilteredInputStream::read(), CRLFToLFFilteredOutputStream::write(), and dotFilteredOutputStream::write().

const string libapi

(

)

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

Returns:

library API version

const string libname

(

)

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

Returns:

library name

const string libversion

(

)

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

Returns:

library version

---

Variable Documentation

const string CRLF = "\r\n"

The CR-LF sequence.

Referenced by header::generate(), and bodyPart::generate().

const string NEW_LINE_SEQUENCE = "\r\n "

Referenced by parameter::generate(), mediaType::generate(), mailbox::generate(), and disposition::generate().

const string::size_type NEW_LINE_SEQUENCE_LENGTH = 1

Referenced by parameter::generate(), mediaType::generate(), and disposition::generate().

const null_ref null = null_ref()

Null reference.

Referenced by bodyPart::clone().

const string NULL_STRING

"Null" (empty) string.

Referenced by headerFieldFactory::create().

const text NULL_TEXT

"Null" (empty) text.

const word NULL_WORD

"Null" (empty) word.

const string SUPPORTED_MIME_VERSION = "1.0"

The current MIME version supported by VMime.