GMime.InternetAddress

g GMime.InternetAddress GMime.InternetAddress GObject.Object GObject.Object GObject.Object->GMime.InternetAddress

Subclasses:

GMime.InternetAddressGroup, GMime.InternetAddressMailbox

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

get_charset ()

get_name ()

set_charset (charset)

set_name (name)

to_string (options, encode)

Virtual Methods

Inherited:

GObject.Object (7)

do_to_string (options, flags, linelen, str)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

changed

object

r

charset

str

r

the charset used for encoding the name

name

str

r

display name

parent_object

GObject.Object

r

parent GObject.Object

Class Details

class GMime.InternetAddress(**kwargs)
Bases:

GObject.Object

Abstract:

Yes

Structure:

GMime.InternetAddressClass

An RFC 2822 Address object.

get_charset()
Returns:

the charset to be used when encoding the name of the mailbox or group if available or None otherwise.

Return type:

str or None

Gets the charset to be used when encoding the name of the mailbox or group.

get_name()
Returns:

the name of the mailbox or group in a form suitable for display if available or None otherwise. If the name is available, the returned string will be in UTF-8.

Return type:

str or None

Gets the display name of the GMime.InternetAddress.

set_charset(charset)
Parameters:

charset (str or None) – the charset to use when encoding the name or None to use the defaults

Set the charset to use for encoding the name of the mailbox or group.

set_name(name)
Parameters:

name (str) – the display name for the address group or mailbox

Set the display name of the GMime.InternetAddress.

Note: The name string should be in UTF-8.

to_string(options, encode)
Parameters:
Returns:

the GMime.InternetAddress object as an allocated string in rfc822 format.

Return type:

str

Allocates a string containing the contents of the GMime.InternetAddress object.

do_to_string(options, flags, linelen, str) virtual
Parameters: