emptyContentHandler Class Reference
Public Member Functions | |
| emptyContentHandler () | |
| ref< contentHandler > | clone () const |
| void | generate (utility::outputStream &os, const vmime::encoding &enc, const string::size_type maxLineLength=lineLengthLimits::infinite) const |
| void | extract (utility::outputStream &os, utility::progressListener *progress=NULL) const |
| void | extractRaw (utility::outputStream &os, utility::progressListener *progress=NULL) const |
| string::size_type | getLength () const |
| bool | isEncoded () const |
| const vmime::encoding & | getEncoding () const |
| bool | isEmpty () const |
Constructor & Destructor Documentation
Member Function Documentation
| ref< contentHandler > clone | ( | ) | const [virtual] |
| void extract | ( | utility::outputStream & | os, | |
| utility::progressListener * | progress = NULL | |||
| ) | const [virtual] |
Extract the contents into the specified stream.
If needed, data will be decoded before being written into the stream.
- Exceptions:
-
exceptions::no_encoder_available if the encoding is not supported
- Parameters:
-
os output stream progress progress listener, or NULL if you do not want to receive progress notifications
Implements contentHandler.
References progressListener::start(), and progressListener::stop().
| void extractRaw | ( | utility::outputStream & | os, | |
| utility::progressListener * | progress = NULL | |||
| ) | const [virtual] |
Extract the contents into the specified stream, without decoding it.
It may be useful in case the encoding is not supported and you want to extract raw data.
- Parameters:
-
os output stream progress progress listener, or NULL if you do not want to receive progress notifications
Implements contentHandler.
References progressListener::start(), and progressListener::stop().
| void generate | ( | utility::outputStream & | os, | |
| const vmime::encoding & | enc, | |||
| const string::size_type | maxLineLength = lineLengthLimits::infinite | |||
| ) | const [virtual] |
Output the contents into the specified stream.
Data will be encoded before being written into the stream. This is used internally by the body object to generate the message, you may not need to use this (see contentHandler::extract() if you want to get the contents).
- Parameters:
-
os output stream enc encoding for output maxLineLength maximum line length for output
Implements contentHandler.
| const vmime::encoding & getEncoding | ( | ) | const [virtual] |
Returns the encoding used for data (or "binary" if not encoded).
- Returns:
- encoding used for data
Implements contentHandler.
References contentHandler::NO_ENCODING.
| string::size_type getLength | ( | ) | const [virtual] |
Returns the actual length of data.
WARNING: this can return 0 if no length was specified when setting data of this object.
- Returns:
- length of data
Implements contentHandler.
| bool isEmpty | ( | ) | const [virtual] |
Returns 'true' if there is no data set.
- Returns:
- true if no data is managed by this object, false otherwise
Implements contentHandler.
| bool isEncoded | ( | ) | const [virtual] |
Returns 'true' if data managed by this object is encoded.
- Returns:
- true if data is encoded, false otherwise
Implements contentHandler.
The documentation for this class was generated from the following files:
