GMime.FormatOptions¶

Fields¶

None

class	`get_default` ()
class	`new` ()
	`add_hidden_header` (header)
	`clear_hidden_headers` ()
	`clone` ()
	`create_newline_filter` (ensure_newline)
	`free` ()
	`get_newline` ()
	`get_newline_format` ()
	`get_param_encoding_method` ()
	`is_hidden_header` (header)
	`remove_hidden_header` (header)
	`set_newline_format` (newline)
	`set_param_encoding_method` (method)

class GMime.FormatOptions¶

Format options for serializing various GMime objects.

classmethod get_default()¶

Gets the default format options.

classmethod new()¶

Returns:: a newly allocated set of GMime.FormatOptions with the default values.
Return type:: GMime.FormatOptions

Creates a new set of GMime.FormatOptions.

add_hidden_header(header)¶

Adds the given header to the list of headers that should be hidden.

clone()¶

create_newline_filter(ensure_newline)¶

Parameters:: ensure_newline (bool) – True if the output must *always* end with a new line
Returns:: a GMime.Filter to convert to the specified new-line format.
Return type:: GMime.Filter

Creates a GMime.Filter suitable for converting line-endings to the currently set new-line format.

get_newline()¶

Gets a string representing the currently set new-line format.

get_newline_format()¶

Gets the new-line format to use when writing out messages and headers.

get_param_encoding_method()¶

Gets the parameter encoding method to use for GMime.Param parameters that do not already have an encoding method specified.

is_hidden_header(header)¶

Gets whether or not the specified header should be hidden.

remove_hidden_header(header)¶

Removes the given header from the list of headers that should be hidden.

set_newline_format(newline)¶

Sets the new-line format that should be used when writing headers and messages.

set_param_encoding_method(method)¶

Parameters:: method (GMime.ParamEncodingMethod) – a GMime.ParamEncodingMethod

Sets the parameter encoding method to use when encoding parameters which do not have an encoding method specified.