internet-address

Name

internet-address -- 

Synopsis



enum        InternetAddressType;
struct      InternetAddress;
InternetAddress* internet_address_new       (void);
InternetAddress* internet_address_new_name  (const gchar *name,
                                             const gchar *addr);
InternetAddress* internet_address_new_group (const gchar *name);
void        internet_address_destroy        (InternetAddress *ia);
void        internet_address_set_name       (InternetAddress *ia,
                                             const gchar *name);
void        internet_address_set_addr       (InternetAddress *ia,
                                             const gchar *addr);
void        internet_address_set_group      (InternetAddress *ia,
                                             GList *group);
void        internet_address_add_member     (InternetAddress *ia,
                                             InternetAddress *member);
GList*      internet_address_parse_string   (const gchar *string);
gchar*      internet_address_to_string      (InternetAddress *ia,
                                             gboolean encode);

Description

Details

enum InternetAddressType

typedef enum {
	INTERNET_ADDRESS_NONE,
	INTERNET_ADDRESS_NAME,
	INTERNET_ADDRESS_GROUP
} InternetAddressType;


struct InternetAddress

struct InternetAddress {
	InternetAddressType type;
	gchar *name;
	union {
		gchar *addr;
		GList *members;
	} value;
};


internet_address_new ()

InternetAddress* internet_address_new       (void);

Returns :a new Internet Address object.


internet_address_new_name ()

InternetAddress* internet_address_new_name  (const gchar *name,
                                             const gchar *addr);

name : person's name
addr : person's address
Returns :a new Internet Address object.


internet_address_new_group ()

InternetAddress* internet_address_new_group (const gchar *name);

name : group name
Returns :a new Internet Address object.


internet_address_destroy ()

void        internet_address_destroy        (InternetAddress *ia);

Destroy the InternetAddress object pointed to by ia.

ia : Internet Address object to destroy


internet_address_set_name ()

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

Set the name of the internet address.

ia : internet address
name : group or contact's name


internet_address_set_addr ()

void        internet_address_set_addr       (InternetAddress *ia,
                                             const gchar *addr);

Set the internet address's address.

ia : internet address
addr : contact's email address


internet_address_set_group ()

void        internet_address_set_group      (InternetAddress *ia,
                                             GList *group);

Set the members of the internet address group.

ia : internet address
group : a list of internet addresses


internet_address_add_member ()

void        internet_address_add_member     (InternetAddress *ia,
                                             InternetAddress *member);

Add a contact to the internet address group.

ia : internet address
member : group member's internet address


internet_address_parse_string ()

GList*      internet_address_parse_string   (const gchar *string);

string : 
Returns : 


internet_address_to_string ()

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

ia : Internet Address object
encode : TRUE if the address should be rfc2047 encoded
Returns :the InternetAddress object as an allocated string in rfc822 format.