| GMime Reference Manual | ||||
|---|---|---|---|---|
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);
void 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_concat (InternetAddressList *list,
InternetAddressList *concat);
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);
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);
typedef struct {
GObject parent_object;
char *name;
} InternetAddress;
An RFC 2822 Address object.
typedef struct {
InternetAddress parent_object;
char *addr;
} InternetAddressMailbox;
An RFC 2822 Mailbox address.
InternetAddress |
parent InternetAddress |
char * |
address string |
typedef struct {
InternetAddress parent_object;
InternetAddressList *members;
} InternetAddressGroup;
An RFC 2822 Group address.
InternetAddress |
parent InternetAddress |
InternetAddressList * |
a InternetAddressList of group members |
typedef struct {
GObject parent_object;
GPtrArray *array;
} InternetAddressList;
A collection of InternetAddress objects.
GObject |
parent GObject |
GPtrArray * |
The array of InternetAddress objects. |
const char* internet_address_get_name (InternetAddress *ia);
Gets the display name of the InternetAddress.
|
a InternetAddress |
Returns : |
the display name of ia.
|
void internet_address_set_name (InternetAddress *ia, const char *name);
Set the display name of the InternetAddress.
|
a InternetAddress |
|
the display name for the address group or mailbox |
char* internet_address_to_string (InternetAddress *ia, gboolean encode);
Allocates a string containing the contents of the InternetAddress object.
|
Internet Address object |
|
TRUE if the address should be rfc2047 encoded
|
Returns : |
the InternetAddress object as an allocated string in rfc822 format. |
InternetAddress* internet_address_mailbox_new (const char *name, const char *addr);
Creates a new InternetAddress object with name name and address
addr.
|
person's name |
|
person's address |
Returns : |
a new InternetAddressMailbox object. |
const char* internet_address_mailbox_get_addr (InternetAddressMailbox *mailbox);
Gets the addr-spec of the internet address mailbox.
|
a InternetAddressMailbox |
Returns : |
the address of the mailbox. |
void internet_address_mailbox_set_addr (InternetAddressMailbox *mailbox, const char *addr);
Set the mailbox address.
|
a InternetAddressMailbox |
|
contact's email address |
InternetAddress* internet_address_group_new (const char *name);
Creates a new InternetAddressGroup object with a display name of
name.
|
group name |
Returns : |
a new InternetAddressGroup object. |
InternetAddressList* internet_address_group_get_members (InternetAddressGroup *group);
Gets the InternetAddressList containing the group members of an rfc822 group address.
|
a InternetAddressGroup |
Returns : |
a InternetAddressList containing the members of group.
|
void internet_address_group_set_members (InternetAddressGroup *group, InternetAddressList *members);
Set the members of the internet address group.
|
a InternetAddressGroup |
|
a InternetAddressList |
void internet_address_group_add_member (InternetAddressGroup *group, InternetAddress *member);
Add a contact to the internet address group.
|
a InternetAddressGroup |
|
a InternetAddress |
InternetAddressList* internet_address_list_new (void);
Creates a new InternetAddressList.
Returns : |
a new InternetAddressList. |
int internet_address_list_length (InternetAddressList *list);
Gets the length of the list.
|
a InternetAddressList |
Returns : |
the number of InternetAddress objects in the list. |
void internet_address_list_clear (InternetAddressList *list);
Clears the list of addresses.
|
a InternetAddressList |
int internet_address_list_add (InternetAddressList *list, InternetAddress *ia);
Adds an InternetAddress to the InternetAddressList.
|
a InternetAddressList |
|
a InternetAddress |
Returns : |
the index of the added InternetAddress. |
void internet_address_list_concat (InternetAddressList *list, InternetAddressList *concat);
Adds all of the addresses in concat to list.
|
a InternetAddressList |
|
a InternetAddressList |
void internet_address_list_insert (InternetAddressList *list, int index, InternetAddress *ia);
Inserts an InternetAddress into the InternetAddressList at the specified index.
|
a InternetAddressList |
|
index to insert at |
|
a InternetAddress |
gboolean internet_address_list_remove (InternetAddressList *list, InternetAddress *ia);
Removes an InternetAddress from the InternetAddressList.
|
a InternetAddressList |
|
a InternetAddress |
Returns : |
TRUE if the specified InternetAddress was removed or
FALSE otherwise.
|
gboolean internet_address_list_remove_at (InternetAddressList *list, int index);
Removes an InternetAddress from the InternetAddressList at the specified index.
|
a InternetAddressList |
|
index to remove |
Returns : |
TRUE if an InternetAddress was removed or FALSE
otherwise.
|
gboolean internet_address_list_contains (InternetAddressList *list, InternetAddress *ia);
Checks whether or not the specified InternetAddress is contained within the InternetAddressList.
|
a InternetAddressList |
|
a InternetAddress |
Returns : |
TRUE if the specified InternetAddress is contained
within the specified InternetAddressList or FALSE otherwise.
|
int internet_address_list_index_of (InternetAddressList *list, InternetAddress *ia);
Gets the index of the specified InternetAddress inside the InternetAddressList.
|
a InternetAddressList |
|
a InternetAddress |
Returns : |
the index of the requested InternetAddress within the
InternetAddressList or -1 if it is not contained within the
InternetAddressList.
|
InternetAddress* internet_address_list_get_address (InternetAddressList *list, int index);
Gets the InternetAddress at the specified index.
|
a InternetAddressList |
|
index of InternetAddress to get |
Returns : |
the InternetAddress at the specified index or NULL if
the index is out of range.
|
void internet_address_list_set_address (InternetAddressList *list, int index, InternetAddress *ia);
Sets the InternetAddress at the specified index to ia.
|
a InternetAddressList |
|
index of InternetAddress to set |
|
a InternetAddress |
char* internet_address_list_to_string (InternetAddressList *list, gboolean encode);
Allocates a string buffer containing the rfc822 formatted addresses
in list.
InternetAddressList* internet_address_list_parse_string (const char *str);
Construct a list of internet addresses from the given string.
|
a string containing internet addresses |
Returns : |
a InternetAddressList or NULL if the input string does
not contain any addresses.
|
void internet_address_list_writer (InternetAddressList *list, GString *str);
Writes the rfc2047-encoded rfc822 formatted addresses in list to
string, folding appropriately.
|
list of internet addresses |
|
string to write to |