Data Type: address_t

The address_t object is used to hold information about a parsed RFC822 address list, and is an opaque data structure to the user. Functions are provided to retrieve information about an address in the address list.

Function: int address_create (address_t *addr, const char *string)

This function allocates and initializes addr by parsing the RFC822 address-list string. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOMEM @ADDRESSEPARSE

Function: void address_destroy (address_t *addr)

The addr is destroyed.

Function: int address_get_email (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the noth email address component of the address list. This address is the plain email address, correctly quoted, suitable for using in an smtp dialog, for example, or as the address part of a contact book entry. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_get_personal (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the display-name describing the noth email address. This display-name is optional, so may not be present. If it is not present, but there is an RFC822 comment after the address, that comment will be returned as the personal phrase, as this is a common usage of the comment even though it is not defined in the internet mail standard. A group is a kind of a special case. It has a display-name, followed by an optional mailbox-list. The display-name will be allocated an address all it's own, but all the other elements (local-part, domain, etc.) will be zero-length. So "a group: ;" is valid, will have a count of 1, but address_get_email(), and all the rest, will return zero-length output. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_get_comments (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the comments extracted while parsing the noth email address. These comments have no defined meaning, and are not currently collected. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_get_email (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the email addr-spec extracted while parsing the noth email address. This will be 0 length for a unix-mbox. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_get_local_part (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the local-part of an email addr-spec extracted while parsing the noth email address. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_get_domain (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the domain of an email addr-spec extracted while parsing the noth email address. This will be 0 length for a unix-mbox. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_get_route (address_t *addr, size_t no, char* buf, size_t len, size_t* n)

Accesses the route of an email addr-spec extracted while parsing the noth email address. This is a rarely used RFC822 address syntax, but is legal in SMTP as well. The entire route is returned as a string, those wishing to parse it should look at <mailutils/parse822.h>. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_is_group (address_t *addr, size_t no, size_t len, int* yes)

Sets *yes to 1 if this address is just the name of a group, 0 otherwise. This is faster than checking if the address has a non-zero length personal, and a zero-length local_part and domain. yes can be null, though that doesn't serve much purpose other than determining that no refers to an address. Currently, there is no way to determine the end of the group. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOENT

Function: int address_to_string (address_t *addr, char* buf, size_t len, size_t* n)

Returns the entire address list as a single RFC822 formatted address list. The return value is 0 on success and a code number on error conditions:

@ADDRESSEINVAL @ADDRESSENOMEM

Function: int address_get_count (address_t addr, size_t* count)

Returns a count of the addresses in the address list. If addr is null, the count is 0. If count is not null, the count will be written to *count. The return value is 0.

Example

#include <stdio.h>
#include <errno.h>
#include <mailutils/address.h>

#define EPARSE ENOENT

static const char* err_name(int e)
{
    struct {
	int e;
	const char* s;
    } map[] = {
#define E(e) { e, #e },
	E(ENOENT)
	E(EINVAL)
	E(ENOMEM)
#undef E
	{ 0, NULL }
    };
    static char s[sizeof(int) * 8 + 3];
    int i;

    for(i = 0; map[i].s; i++) {
	if(map[i].e == e)
	    return map[i].s;
    }
    sprintf(s, "[%d]", e);

    return s;
}

static int parse(const char* str)
{
    size_t no = 0;
    size_t pcount = 0;
    int status;

    char buf[BUFSIZ];

    address_t  address = NULL;

    status = address_create(&address, str);

    address_get_count(address, &pcount);

    if(status) {
	printf("%s=> error %s\n\n", str, err_name(status));
	return 0;
    } else {
	printf("%s=> pcount %d\n", str, pcount);
    }

    for(no = 1; no <= pcount; no++) {
	size_t got = 0;
	int isgroup;

	address_is_group(address, no, &isgroup);

	printf("%d ", no);

	if(isgroup) {
	  address_get_personal(address, no, buf, sizeof(buf), &got);

	  printf("group <%s>\n", buf);
	} else {
	  address_get_email(address, no, buf, sizeof(buf), 0);

	  printf("email <%s>\n", buf);
	}

	address_get_personal(address, no, buf, sizeof(buf), &got);

	if(got && !isgroup) printf("   personal <%s>\n", buf);

	address_get_comments(address, no, buf, sizeof(buf), &got);

	if(got) printf("   comments <%s>\n", buf);

	address_get_local_part(address, no, buf, sizeof(buf), &got);

	if(got) {
	    printf("   local-part <%s>", buf);

	    address_get_domain(address, no, buf, sizeof(buf), &got);

	    if(got) printf(" domain <%s>", buf);

	    printf("\n");
	}

	address_get_route(address, no, buf, sizeof(buf), &got);

	if(got) printf("   route <%s>\n", buf);
    }
    address_destroy(&address);

    printf("\n");

    return 0;
}

static int parseinput(void)
{
    char buf[BUFSIZ];

    while(fgets(buf, sizeof(buf), stdin) != 0) {
	buf[strlen(buf) - 1] = 0;
	parse(buf);
    }

    return 0;
}

int main(int argc, const char *argv[])
{
    argc = 1;

    if(!argv[argc]) {
	return parseinput();
    }
    for(; argv[argc]; argc++) {
	if(strcmp(argv[argc], "-") == 0) {
	    parseinput();
	} else {
	    parse(argv[argc]);
	}
    }

    return 0;
}

Go to the first, previous, next, last section, table of contents.