GMime.ParamList¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`parse` (options, str)
	`clear` ()
	`encode` (options, fold)
	`get_parameter` (name)
	`get_parameter_at` (index)
	`length` ()
	`remove` (name)
	`remove_at` (index)
	`set_parameter` (name, value)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
array	[`object`]	r
changed	`object`	r
parent_object	`GObject.Object`	r

Class Details¶

class GMime.ParamList(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GMime.ParamListClass

A list of Content-Type or Content-Disposition parameters.

classmethod new()¶

Returns:: a new GMime.ParamList.
Return type:: GMime.ParamList

Creates a new Content-Type or Content-Disposition parameter list.

classmethod parse(options, str)¶

Parameters:

options (GMime.ParserOptions) – a GMime.ParserOptions or None
str (str) – a string to parse

Returns:

a new GMime.ParamList.

Return type:

GMime.ParamList

Parses the input string into a parameter list.

clear()¶: Clears the list of parameters.

encode(options, fold)¶

Parameters:

options (GMime.FormatOptions or None) – a GMime.FormatOptions or None
fold (bool) – True if the parameter list should be folded; otherwise, False

Returns:

the output string buffer

Return type:

str: GLib.String

Encodes the parameter list into str, folding lines if required.

get_parameter(name)¶

Parameters:: name (str) – the name of the parameter
Returns:: the requested GMime.Param.
Return type:: GMime.Param

Gets the GMime.Param with the given name.

get_parameter_at(index)¶

Parameters:: index (int) – the index of the requested parameter
Returns:: the GMime.Param at the specified index.
Return type:: GMime.Param

Gets the GMime.Param at the specified index.

length()¶

Returns:: the number of GMime.Param items in the list.
Return type:: int

Gets the length of the list.

remove(name)¶

Parameters:: name (str) – the name of the parameter
Returns:: True if the specified parameter was removed or False otherwise.
Return type:: bool

Removes a parameter from the GMime.ParamList.

remove_at(index)¶

Parameters:: index (int) – index of the param to remove
Returns:: True if a GMime.Param was removed or False otherwise.
Return type:: bool

Removes a GMime.Param from the GMime.ParamList at the specified index.

set_parameter(name, value)¶

Parameters:

name (str) – The name of the parameter
value (str) – The parameter value

Sets the specified parameter to value.