doc/book/basics.tex

24 In VMime, these two types of references are known as {\vcode vmime::shared\_ptr}
25 and {\vcode vmime::weak\_ptr}, respectively.
28 of smart pointers to a more standard one: either Boost {\vcode shared\_ptr<>}
32 {\vcode vmime::ref <>} is replaced with {\vcode vmime::shared\_ptr <>}
34 {\vcode vmime::weak\_ref <>} is replaced with {\vcode vmime::weak\_ptr <>}
36 {\vcode vmime::create <>} is replaced with {\vcode vmime::make\_shared <>}
42 {\vcode vmime::object} class, which is responsible for
45 use the function {\vcode vmime::make\_shared} instead of the {\vcode new}
87 the {\vcode static\_cast()}, {\vcode dynamic\_cast()} and {\vcode const\_cast()}
88 equivalents on {\vcode vmime::shared\_ptr} and {\vcode vmime::weak\_ptr} objects:
145 In this example, neither {\vcode p} nor {\vcode c} will be deleted when
146 exiting {\vcode main()}. That's because {\vcode p} indirectly points to itself
147 {\em via} {\vcode c}, and {\em vice versa}. The solution is to use a weak
156 objects. Note that when the parent is deleted, the {\vcode m\_parent} member
175 {\vcode exception::other()} returns the next exception in the chain,
212 by using specialized classes of {\vcode vmime::exception}).
218 \subsection{The {\vcode component} class} % ----------------------------------
221 {\vcode component}. This includes the message itself (classes {\vcode message}
222 and {\vcode bodyPart}), the header, the header fields and the value of each
226 these components (methods {\vcode parse()} and {\vcode generate()}). It also
228 process or the structure (methods {\vcode getParsedOffset()},
229 {\vcode getParsedLength()} and {\vcode getChildComponents()}).
233 media type, etc. They all inherit from {\vcode component} too.
239 specification. The object {\vcode vmime::datetime} is used to manipulate date
243 {\vcode vmime::datetime} object:
245 \begin{lstlisting}[caption={Using {\vcode vmime::datetime} object}]
270 In VMime, the object {\vcode vmime::mediaType} represents a media type. There
272 {\vcode vmime::mediaTypes} namespace. For example, you can instanciate a new
292 The {\vcode vmime::address} class is an abstract type for representing an
293 address: it can be either a mailbox (type {\vcode vmime::mailbox}) or a
294 mailbox group (type {\vcode vmime::mailboxGroup}). A mailbox is composed of
341 field value inherit from the {\vcode headerFieldValue} class.
344 Instead, you should use the {\vcode headerFieldFactory} object. This ensures
353 By default, all unregistered fields have a value of type {\vcode text}.
408 {\vcode parameterizedHeaderField} class which provides methods to deal with
409 these parameters: {\vcode appendParameter()}, {\vcode getParameterAt()}...
412 a value of type {\vcode vmime::text}. Parameters provide helper functions to
446 \vnote{In both cases, an exception {\vcode no\_such\_parameter} can be
484 \item {\vcode inputStreamAdapter} and {\vcode outputStreamAdapter}: allow
486 \item {\vcode inputStreamStringAdapter} and
487 {\vcode outputStreamStringAdapter}: use a {\vcode vmime::string} object to
520 {\vcode vmime::utility::filteredInputStream} or
521 {\vcode vmime::utility::filteredOutputStream} and are used like adapters (some
525 the {\vcode charsetFilteredOutputStream}, which performs inline conversion
529 important to call {\vcode flush()} on it to flush the internal buffer.
530 If {\vcode flush()} is not called, not all data may be written to the
546 You can extract data in a content handler using the {\vcode extract()} method
547 (which automatically decodes data if encoded) or {\vcode extractRaw()} (which
620 You will see later that the {\vcode vmime::fileAttachment} class already
630 With the {\vcode vmime::charset} object, VMime supports conversion between
632 existing platforms. See {\vcode vmime::charset} and
633 {\vcode vmime::charsetConverter} in the class documentation to know more
670 manipulating 8-bit data: {\vcode vmime::text} and {\vcode vmime::word}. A word
679 \begin{lstlisting}[caption={Creating \vcode{vmime::text} objects}]
697 {\vcode vmime::text::decodeAndUnfold()} static method to create a text object
716 {\vcode vmime::text} also provides a function to convert all the words to
720 \begin{lstlisting}[caption={Converting data in a {\vcode vmime::text} to a
740 data encoding and decoding using the {\vcode vmime::utility::encoder::encoder} object.
806 The {\vcode vmime::utility::progressListener} interface is rather simple:
814 {\vcode start()} and {\vcode stop()} are called at the beginning and the end
815 of the operation, respectively. {\vcode progress()} is called each time the