Camel.Address

g Camel.Address Camel.Address GObject.Object GObject.Object GObject.Object->Camel.Address

Subclasses:

Camel.InternetAddress, Camel.NNTPAddress

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

cat (source)

copy (source)

decode (raw)

encode ()

format ()

length ()

new_clone ()

remove (index)

unformat (raw)

Virtual Methods

Inherited:

GObject.Object (7)

do_cat (source)

do_decode (raw)

do_encode ()

do_format ()

do_length ()

do_remove (index)

do_unformat (raw)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

GObject.Object

r

Class Details

class Camel.Address(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Camel.AddressClass

classmethod new()
Returns:

a new Camel.Address object

Return type:

Camel.Address

Create a new Camel.Address object.

cat(source)
Parameters:

source (Camel.Address) – source Camel.Address object

Returns:

the number of addresses concatenated

Return type:

int

Concatenate one address onto another. The addresses must be of the same type.

copy(source)
Parameters:

source (Camel.Address) – source Camel.Address object

Returns:

the number of addresses copied

Return type:

int

Copy the contents of one address into another.

decode(raw)
Parameters:

raw (str) – raw address description

Returns:

the number of addresses parsed or -1 on fail

Return type:

int

Construct a new address from a raw address field.

encode()
Returns:

the encoded address

Return type:

str

Encode an address in a format suitable for a raw header.

format()
Returns:

a newly allocated string containing the formatted addresses

Return type:

str

Format an address in a format suitable for display.

length()
Returns:

the number of addresses contained in self

Return type:

int

Get the number of addresses stored in the address self.

new_clone()
Returns:

the cloned address

Return type:

Camel.Address

Clone an existing address type.

remove(index)
Parameters:

index (int) – The address to remove, use -1 to remove all address.

Remove an address by index, or all addresses.

unformat(raw)
Parameters:

raw (str) – raw address description

Returns:

the number of addresses parsed or -1 on fail

Return type:

int

Attempt to convert a previously formatted and/or edited address back into internal form.

do_cat(source) virtual
Parameters:

source (Camel.Address) – source Camel.Address object

Returns:

the number of addresses concatenated

Return type:

int

Concatenate one address onto another. The addresses must be of the same type.

do_decode(raw) virtual
Parameters:

raw (str) – raw address description

Returns:

the number of addresses parsed or -1 on fail

Return type:

int

Construct a new address from a raw address field.

do_encode() virtual
Returns:

the encoded address

Return type:

str

Encode an address in a format suitable for a raw header.

do_format() virtual
Returns:

a newly allocated string containing the formatted addresses

Return type:

str

Format an address in a format suitable for display.

do_length() virtual
Returns:

the number of addresses contained in addr

Return type:

int

Get the number of addresses stored in the address addr.

do_remove(index) virtual
Parameters:

index (int) – The address to remove, use -1 to remove all address.

Remove an address by index, or all addresses.

do_unformat(raw) virtual
Parameters:

raw (str) – raw address description

Returns:

the number of addresses parsed or -1 on fail

Return type:

int

Attempt to convert a previously formatted and/or edited address back into internal form.