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_t >	byteArray
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

byte_t

typedef vmime_uint8 byte_t

byteArray

typedef std::vector<byte_t> byteArray

char_t

typedef int char_t

port_t

typedef unsigned short port_t

size_t

typedef std::size_t size_t

string

typedef std::string string

Function Documentation

begin()

T* vmime::begin

(

T(&)

array[N]

)

Referenced by stringUtils::appendBytesToString(), stringUtils::findFirstNonASCIIchar(), parserInputStreamAdapter::findNext(), parserInputStreamAdapter::matchBytes(), encoding::operator!=(), and datetime::parseImpl().

cbegin()

T const* vmime::cbegin

(

T const (&)

array[N]

)

cend()

T const* vmime::cend

(

T const (&)

array[N]

)

clone() [1/2]

shared_ptr< T > clone

(

shared_ptr< T >

obj

)

Clone helper (using a shared_ptr).

Clone helper (using a const shared_ptr).

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

Referenced by MDNHelper::attachMDNRequest(), header::clone(), messageBuilder::construct(), messageIdSequence::copyFrom(), mailboxGroup::copyFrom(), addressList::copyFrom(), parameterizedHeaderField::copyFrom(), header::copyFrom(), IMAPMessage::fetchPartHeader(), htmlTextPart::generateIn(), header::getField(), IMAPFolder::getMessageNumbersStartingOnUID(), defaultAttachment::operator=(), plainTextPart::parse(), mailboxGroup::parseImpl(), transport::send(), plainTextPart::setText(), headerField::setValue(), headerField::setValueConst(), mailboxList::toAddressList(), and addressList::toMailboxList().

clone() [2/2]

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()).

constCast()

shared_ptr<X> vmime::constCast

(

const shared_ptr< Y > &

obj

)

Const cast helper.

copy_vector()

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

References count(), and vmime::lineLengthLimits::infinite.

Referenced by text::decodeAndUnfold(), messageIdSequence::getChildComponents(), mailboxGroup::getChildComponents(), addressList::getChildComponents(), text::getChildComponents(), body::getChildComponents(), header::getChildComponents(), and text::parseImpl().

count()

size_t vmime::count

(

T

const(&)[N]

)

Referenced by copy_vector(), maildirFolder::copyMessages(), stringUtils::countASCIIchars(), text::createFromString(), uuEncoder::decode(), b64Encoder::decode(), b64Encoder::encode(), kmailMaildirFormat::folderPathToFileSystemPath(), relay::generateImpl(), POP3Folder::getStatus(), encoding::operator!=(), inputStreamByteBufferAdapter::read(), inputStreamStringAdapter::read(), inputStreamStringProxyAdapter::read(), SASLSocket::receiveRaw(), maildirFolderStatus::setMessageCount(), POP3FolderStatus::setMessageCount(), inputStreamByteBufferAdapter::skip(), inputStreamStringAdapter::skip(), inputStreamStringProxyAdapter::skip(), seekableInputStreamRegionAdapter::skip(), stopSequenceFilteredInputStream< COUNT >::skip(), SMTPChunkingOutputStreamAdapter::SMTPChunkingOutputStreamAdapter(), POP3Folder::status(), maildirFolder::status(), IMAPFolderStatus::updateFromResponse(), outputStreamByteArrayAdapter::writeImpl(), SMTPChunkingOutputStreamAdapter::writeImpl(), dotFilteredOutputStream::writeImpl(), CRLFToLFFilteredOutputStream::writeImpl(), LFToCRLFFilteredOutputStream::writeImpl(), socket::~socket(), and tracer::~tracer().

dynamicCast()

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.

end()

T* vmime::end

(

T(&)

array[N]

)

Referenced by stringUtils::appendBytesToString(), charsetConverter_idna::convert(), stringUtils::countASCIIchars(), parserHelpers::findEOL(), stringUtils::findFirstNonASCIIchar(), parserInputStreamAdapter::findNext(), path::fromString(), word::generateImpl(), header::getField(), POP3Response::getLineCount(), headerField::getValue(), parameter::getValueAs(), stringUtils::isStringEqualNoCase(), body::isValidBoundary(), parserInputStreamAdapter::matchBytes(), url::operator string(), contentDisposition::parseImpl(), path::parseImpl(), relay::parseImpl(), mediaType::parseImpl(), mailbox::parseImpl(), messageId::parseImpl(), emailAddress::parseImpl(), bodyPart::parseImpl(), parameter::parseImpl(), charset::parseImpl(), encoding::parseImpl(), messageIdSequence::parseImpl(), mailboxList::parseImpl(), addressList::parseImpl(), mailboxGroup::parseImpl(), parameterizedHeaderField::parseImpl(), datetime::parseImpl(), body::parseImpl(), address::parseNext(), headerField::parseNext(), word::parseWithState(), dotFilteredInputStream::read(), stopSequenceFilteredInputStream< COUNT >::read(), propertySet::removeProperty(), stringUtils::unquote(), word::word(), dotFilteredOutputStream::writeImpl(), CRLFToLFFilteredOutputStream::writeImpl(), LFToCRLFFilteredOutputStream::writeImpl(), and parameterizedHeaderField::~parameterizedHeaderField().

libapi()

const string VMIME_EXPORT libapi

(

)

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

Returns

library API version

libname()

const string VMIME_EXPORT libname

(

)

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

Returns

library name

libversion()

const string VMIME_EXPORT libversion

(

)

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

Returns

library version

Variable Documentation

CRLF

VMIME_EXPORT const string CRLF = "\r\n"

The CR-LF sequence.

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

g_charsetEncodingMap

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("", "")
}

Referenced by charset::getRecommendedEncoding().

NEW_LINE_SEQUENCE

VMIME_EXPORT const string NEW_LINE_SEQUENCE = "\r\n "

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

NEW_LINE_SEQUENCE_LENGTH

VMIME_EXPORT const size_t NEW_LINE_SEQUENCE_LENGTH = 1

Referenced by mediaType::generateImpl(), disposition::generateImpl(), parameter::generateImpl(), word::generateImpl(), and parameter::getGeneratedSize().

npos

VMIME_EXPORT const size_t npos = std::numeric_limits <size_t>::max()

Constant value with the greatest possible value for an element of type size_t.

The meaning is "infinite" or "until the end".

Referenced by urlUtils::encode(), maildirMessage::fetchPartHeader(), stringUtils::findFirstNonASCIIchar(), parserInputStreamAdapter::findNext(), body::findNextBoundaryPosition(), path::fromString(), word::generateImpl(), POP3Response::getLineCount(), charset::getRecommendedEncoding(), wordEncoder::isEncodingNeeded(), body::isValidBoundary(), courierMaildirFormat::listFolders(), stringUtils::needQuoting(), url::operator string(), htmlTextPart::parse(), path::parseImpl(), relay::parseImpl(), disposition::parseImpl(), parameter::parseImpl(), parameterizedHeaderField::parseImpl(), body::parseImpl(), word::parseWithState(), stringUtils::quote(), and SMTPResponse::readResponse().

NULL_STRING

VMIME_EXPORT const string NULL_STRING

"Null" (empty) string.

Referenced by headerFieldFactory::create(), body::parseImpl(), and headerFieldFactory::registerFieldValue().

NULL_TEXT

VMIME_EXPORT const text NULL_TEXT

"Null" (empty) text.

NULL_WORD

VMIME_EXPORT const word NULL_WORD

"Null" (empty) word.

SUPPORTED_MIME_VERSION

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().