| GMime 2.4 Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct GMimeFilterBest; enum GMimeBestEncoding; enum GMimeFilterBestFlags; GMimeFilter * g_mime_filter_best_new (GMimeFilterBestFlags flags); const char * g_mime_filter_best_charset (GMimeFilterBest *best); GMimeContentEncoding g_mime_filter_best_encoding (GMimeFilterBest *best,GMimeBestEncoding required);
A GMimeFilter which is meant to determine the best charset and/or transfer encoding suitable for the stream which is filtered through it.
struct GMimeFilterBest;
A filter for calculating the best encoding and/or charset to encode the data passed through it.
typedef enum {
GMIME_BEST_ENCODING_7BIT,
GMIME_BEST_ENCODING_8BIT,
GMIME_BEST_ENCODING_BINARY
} GMimeBestEncoding;
Used with g_mime_filter_best_encoding() as the 'required'
argument. These values provide a means of letting the filter know
what the encoding requirements are for the stream.
typedef enum {
GMIME_FILTER_BEST_CHARSET = (1 << 0),
GMIME_FILTER_BEST_ENCODING = (1 << 1)
} GMimeFilterBestFlags;
Bit flags to enable charset and/or encoding scanning to make educated guesses as to what the best charset and/or encodings to use for the content passed through the filter.
GMimeFilter * g_mime_filter_best_new (GMimeFilterBestFlags flags);
Creates a new GMimeFilterBest filter. flags are used to determine
which information to keep statistics of. If the
GMIME_FILTER_BEST_CHARSET bit is set, the filter will be able to
compute the best charset for encoding the stream of data
filtered. If the GMIME_FILTER_BEST_ENCODING bit is set, the filter
will be able to compute the best Content-Transfer-Encoding for use
with the stream being filtered.
Note: In order for the g_mime_filter_best_charset() function to
work, the stream being filtered MUST already be encoded in UTF-8.
|
filter flags |
Returns : |
a new best filter with flags flags. |
const char * g_mime_filter_best_charset (GMimeFilterBest *best);
Calculates the best charset for encoding the stream filtered
through the best filter.
|
best filter |
Returns : |
a pointer to a string containing the name of the charset
best suited for the text filtered through best. |
GMimeContentEncoding g_mime_filter_best_encoding (GMimeFilterBest *best,GMimeBestEncoding required);
Calculates the best Content-Transfer-Encoding for the stream
filtered through best that fits within the required encoding.
|
best filter |
|
encoding that all data must fit within |
Returns : |
the best encoding for the stream filtered by best. |