InternetAddress

InternetAddress — Internet addresses

Synopsis

struct              InternetAddress;
const char *        internet_address_get_name           (InternetAddress *ia);
void                internet_address_set_name           (InternetAddress *ia,
                                                         const char *name);
char *              internet_address_to_string          (InternetAddress *ia,
                                                         gboolean encode);

Description

An InternetAddress is the base class for InternetAddressGroup and InternetAddressMailbox.

Details

struct InternetAddress

struct InternetAddress {
	GObject parent_object;
	gpointer priv;
	
	char *name;
};

An RFC 2822 Address object.

GObject parent_object;

parent GObject

gpointer priv;

private data

char *name;

display name

internet_address_get_name ()

const char *        internet_address_get_name           (InternetAddress *ia);

Gets the display name of the InternetAddress.

ia :

a InternetAddress

Returns :

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

internet_address_set_name ()

void                internet_address_set_name           (InternetAddress *ia,
                                                         const char *name);

Set the display name of the InternetAddress.

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

ia :

a InternetAddress

name :

the display name for the address group or mailbox

internet_address_to_string ()

char *              internet_address_to_string          (InternetAddress *ia,
                                                         gboolean encode);

Allocates a string containing the contents of the InternetAddress object.

ia :

Internet Address object

encode :

TRUE if the address should be rfc2047 encoded

Returns :

the InternetAddress object as an allocated string in rfc822 format.

See Also

InternetAddressGroup, InternetAddressMailbox