|  |  |  | Camel Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct CamelAddress; CamelAddress * camel_address_new (void); CamelAddress * camel_address_new_clone (CamelAddress *addr); gint camel_address_length (CamelAddress *addr); gint camel_address_decode (CamelAddress *addr,const gchar *raw); gchar * camel_address_encode (CamelAddress *addr); gint camel_address_unformat (CamelAddress *addr,const gchar *raw); gchar * camel_address_format (CamelAddress *addr); gint camel_address_cat (CamelAddress *dest,CamelAddress *source); gint camel_address_copy (CamelAddress *dest,CamelAddress *source); void camel_address_remove (CamelAddress *addr,gint index);
GObject +----CamelObject +----CamelAddress +----CamelInternetAddress +----CamelNNTPAddress
CamelAddress *      camel_address_new                   (void);
Create a new CamelAddress object.
| Returns : | a new CamelAddress object | 
CamelAddress *      camel_address_new_clone             (CamelAddress *addr);
Clone an existing address type.
| 
 | a CamelAddress object | 
| Returns : | the cloned address | 
gint                camel_address_length                (CamelAddress *addr);
Get the number of addresses stored in the address addr.
| 
 | a CamelAddress object | 
| Returns : | the number of addresses contained in addr | 
gint camel_address_decode (CamelAddress *addr,const gchar *raw);
Construct a new address from a raw address field.
| 
 | a CamelAddress object | 
| 
 | raw address description | 
| Returns : | the number of addresses parsed or -1on fail | 
gchar *             camel_address_encode                (CamelAddress *addr);
Encode an address in a format suitable for a raw header.
| 
 | a CamelAddress object | 
| Returns : | the encoded address | 
gint camel_address_unformat (CamelAddress *addr,const gchar *raw);
Attempt to convert a previously formatted and/or edited address back into internal form.
| 
 | a CamelAddress object | 
| 
 | raw address description | 
| Returns : | the number of addresses parsed or -1on fail | 
gchar *             camel_address_format                (CamelAddress *addr);
Format an address in a format suitable for display.
| 
 | a CamelAddress object | 
| Returns : | a newly allocated string containing the formatted addresses | 
gint camel_address_cat (CamelAddress *dest,CamelAddress *source);
Concatenate one address onto another. The addresses must be of the same type.
| 
 | destination CamelAddress object | 
| 
 | source CamelAddress object | 
| Returns : | the number of addresses concatenated | 
gint camel_address_copy (CamelAddress *dest,CamelAddress *source);
Copy the contents of one address into another.
| 
 | destination CamelAddress object | 
| 
 | source CamelAddress object | 
| Returns : | the number of addresses copied | 
void camel_address_remove (CamelAddress *addr,gint index);
Remove an address by index, or all addresses.
| 
 | a CamelAddress object | 
| 
 | The address to remove, use -1to remove all address. |