InternetAddress

InternetAddress — Internet addresses

Synopsis

                    InternetAddress;
                    InternetAddressMailbox;
                    InternetAddressGroup;
                    InternetAddressList;
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);
InternetAddress*    internet_address_mailbox_new        (const char *name,
                                                         const char *addr);
const char*         internet_address_mailbox_get_addr   (InternetAddressMailbox *mailbox);
void                internet_address_mailbox_set_addr   (InternetAddressMailbox *mailbox,
                                                         const char *addr);
InternetAddress*    internet_address_group_new          (const char *name);
InternetAddressList* internet_address_group_get_members (InternetAddressGroup *group);
void                internet_address_group_set_members  (InternetAddressGroup *group,
                                                         InternetAddressList *members);
int                 internet_address_group_add_member   (InternetAddressGroup *group,
                                                         InternetAddress *member);
InternetAddressList* internet_address_list_new          (void);
int                 internet_address_list_length        (InternetAddressList *list);
void                internet_address_list_clear         (InternetAddressList *list);
int                 internet_address_list_add           (InternetAddressList *list,
                                                         InternetAddress *ia);
void                internet_address_list_insert        (InternetAddressList *list,
                                                         int index,
                                                         InternetAddress *ia);
gboolean            internet_address_list_remove        (InternetAddressList *list,
                                                         InternetAddress *ia);
gboolean            internet_address_list_remove_at     (InternetAddressList *list,
                                                         int index);
gboolean            internet_address_list_contains      (InternetAddressList *list,
                                                         InternetAddress *ia);
int                 internet_address_list_index_of      (InternetAddressList *list,
                                                         InternetAddress *ia);
InternetAddress*    internet_address_list_get_address   (InternetAddressList *list,
                                                         int index);
void                internet_address_list_set_address   (InternetAddressList *list,
                                                         int index,
                                                         InternetAddress *ia);
void                internet_address_list_prepend       (InternetAddressList *list,
                                                         InternetAddressList *prepend);
void                internet_address_list_append        (InternetAddressList *list,
                                                         InternetAddressList *append);
char*               internet_address_list_to_string     (InternetAddressList *list,
                                                         gboolean encode);
InternetAddressList* internet_address_list_parse_string (const char *str);
void                internet_address_list_writer        (InternetAddressList *list,
                                                         GString *str);

Description

An InternetAddress represents what is commonly referred to as an E-Mail address.

Details

InternetAddress

typedef struct {
	GObject parent_object;
	
	char *name;
} InternetAddress;

An RFC 2822 Address object.

GObject parent_object;

parent GObject

char *name;

display name

InternetAddressMailbox

typedef struct {
	InternetAddress parent_object;
	
	char *addr;
} InternetAddressMailbox;

An RFC 2822 Mailbox address.

InternetAddress parent_object;

parent InternetAddress

char *addr;

address string

InternetAddressGroup

typedef struct {
	InternetAddress parent_object;
	
	InternetAddressList *members;
} InternetAddressGroup;

An RFC 2822 Group address.

InternetAddress parent_object;

parent InternetAddress

InternetAddressList *members;

a InternetAddressList of group members

InternetAddressList

typedef struct {
	GObject parent_object;
	
	GPtrArray *array;
} InternetAddressList;

A collection of InternetAddress objects.

GObject parent_object;

parent GObject

GPtrArray *array;

The array of InternetAddress objects.

internet_address_get_name ()

const char*         internet_address_get_name           (InternetAddress *ia);

Gets the display name of the InternetAddress.

ia :

a InternetAddress

Returns :

the display name of ia.

internet_address_set_name ()

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

Set the display name of the InternetAddress.

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.

internet_address_mailbox_new ()

InternetAddress*    internet_address_mailbox_new        (const char *name,
                                                         const char *addr);

Creates a new InternetAddress object with name name and address addr.

name :

person's name

addr :

person's address

Returns :

a new InternetAddressMailbox object.

internet_address_mailbox_get_addr ()

const char*         internet_address_mailbox_get_addr   (InternetAddressMailbox *mailbox);

Gets the addr-spec of the internet address mailbox.

mailbox :

a InternetAddressMailbox

Returns :

the address of the mailbox.

internet_address_mailbox_set_addr ()

void                internet_address_mailbox_set_addr   (InternetAddressMailbox *mailbox,
                                                         const char *addr);

Set the mailbox address.

mailbox :

a InternetAddressMailbox

addr :

contact's email address

internet_address_group_new ()

InternetAddress*    internet_address_group_new          (const char *name);

Creates a new InternetAddressGroup object with a display name of name.

name :

group name

Returns :

a new InternetAddressGroup object.

internet_address_group_get_members ()

InternetAddressList* internet_address_group_get_members (InternetAddressGroup *group);

Gets the InternetAddressList containing the group members of an rfc822 group address.

group :

a InternetAddressGroup

Returns :

a InternetAddressList containing the members of group.

internet_address_group_set_members ()

void                internet_address_group_set_members  (InternetAddressGroup *group,
                                                         InternetAddressList *members);

Set the members of the internet address group.

group :

a InternetAddressGroup

members :

a InternetAddressList

internet_address_group_add_member ()

int                 internet_address_group_add_member   (InternetAddressGroup *group,
                                                         InternetAddress *member);

Add a contact to the internet address group.

group :

a InternetAddressGroup

member :

a InternetAddress

Returns :

the index of the newly added member.

internet_address_list_new ()

InternetAddressList* internet_address_list_new          (void);

Creates a new InternetAddressList.

Returns :

a new InternetAddressList.

internet_address_list_length ()

int                 internet_address_list_length        (InternetAddressList *list);

Gets the length of the list.

list :

a InternetAddressList

Returns :

the number of InternetAddress objects in the list.

internet_address_list_clear ()

void                internet_address_list_clear         (InternetAddressList *list);

Clears the list of addresses.


internet_address_list_add ()

int                 internet_address_list_add           (InternetAddressList *list,
                                                         InternetAddress *ia);

Adds an InternetAddress to the InternetAddressList.

list :

a InternetAddressList

ia :

a InternetAddress

Returns :

the index of the added InternetAddress.

internet_address_list_insert ()

void                internet_address_list_insert        (InternetAddressList *list,
                                                         int index,
                                                         InternetAddress *ia);

Inserts an InternetAddress into the InternetAddressList at the specified index.

list :

a InternetAddressList

index :

index to insert at

ia :

a InternetAddress

internet_address_list_remove ()

gboolean            internet_address_list_remove        (InternetAddressList *list,
                                                         InternetAddress *ia);

Removes an InternetAddress from the InternetAddressList.

list :

a InternetAddressList

ia :

a InternetAddress

Returns :

TRUE if the specified InternetAddress was removed or FALSE otherwise.

internet_address_list_remove_at ()

gboolean            internet_address_list_remove_at     (InternetAddressList *list,
                                                         int index);

Removes an InternetAddress from the InternetAddressList at the specified index.

list :

a InternetAddressList

index :

index to remove

Returns :

TRUE if an InternetAddress was removed or FALSE otherwise.

internet_address_list_contains ()

gboolean            internet_address_list_contains      (InternetAddressList *list,
                                                         InternetAddress *ia);

Checks whether or not the specified InternetAddress is contained within the InternetAddressList.

list :

a InternetAddressList

ia :

a InternetAddress

Returns :

TRUE if the specified InternetAddress is contained within the specified InternetAddressList or FALSE otherwise.

internet_address_list_index_of ()

int                 internet_address_list_index_of      (InternetAddressList *list,
                                                         InternetAddress *ia);

Gets the index of the specified InternetAddress inside the InternetAddressList.

list :

a InternetAddressList

ia :

a InternetAddress

Returns :

the index of the requested InternetAddress within the InternetAddressList or -1 if it is not contained within the InternetAddressList.

internet_address_list_get_address ()

InternetAddress*    internet_address_list_get_address   (InternetAddressList *list,
                                                         int index);

Gets the InternetAddress at the specified index.

list :

a InternetAddressList

index :

index of InternetAddress to get

Returns :

the InternetAddress at the specified index or NULL if the index is out of range.

internet_address_list_set_address ()

void                internet_address_list_set_address   (InternetAddressList *list,
                                                         int index,
                                                         InternetAddress *ia);

Sets the InternetAddress at the specified index to ia.

list :

a InternetAddressList

index :

index of InternetAddress to set

ia :

a InternetAddress

internet_address_list_prepend ()

void                internet_address_list_prepend       (InternetAddressList *list,
                                                         InternetAddressList *prepend);

Inserts all of the addresses in prepend to the beginning of list.

list :

a InternetAddressList

prepend :

a InternetAddressList

internet_address_list_append ()

void                internet_address_list_append        (InternetAddressList *list,
                                                         InternetAddressList *append);

Adds all of the addresses in append to list.


internet_address_list_to_string ()

char*               internet_address_list_to_string     (InternetAddressList *list,
                                                         gboolean encode);

Allocates a string buffer containing the rfc822 formatted addresses in list.

list :

list of internet addresses

encode :

TRUE if the address should be rfc2047 encoded

Returns :

a string containing the list of addresses in rfc822 format or NULL if no addresses are contained in the list.

internet_address_list_parse_string ()

InternetAddressList* internet_address_list_parse_string (const char *str);

Construct a list of internet addresses from the given string.

str :

a string containing internet addresses

Returns :

a InternetAddressList or NULL if the input string does not contain any addresses.

internet_address_list_writer ()

void                internet_address_list_writer        (InternetAddressList *list,
                                                         GString *str);

Writes the rfc2047-encoded rfc822 formatted addresses in list to string, folding appropriately.

list :

list of internet addresses

str :

string to write to