libens

Email Notification System

A library that provides application level email logging. The main goal of this library is to provide functionality to programmers for sending log type emails in their programs. The library handles the logic which determines when emails should be sent and can operate in two modes as described in the next section.

ENS is configured by groupings. Each group has their own set of characteristics so emails can be controlled in each group individually. Therefore, each group has their own timers and do not affect the other groups.

---

ENS_GROUP_MODE_DROP

Sends an email at most, every "interval" seconds at which the group is configured. Any email that is attempted to be sent before the interval has expired is ignored.

---

ENS_GROUP_MODE_COLLECT

Sends an email at most, every "interval" seconds at which the group is configured. Any email that is attempted to be sent before the interval has expired is queued and when the timer expires, an email is sent with all the queued emails concatenated into a single email.

---

Prerequisites

ENS uses libcurl internally to send emails.

Installing

Installation is done by using the Makefile in the source directory. By default, the library is installed in /usr/local/lib and the header is stored in /usr/local/include.

cd src/
make
make install

Linkage

gcc -o myprogram -lens mysource.c

Documentation

Documentation is handled by Doxygen and can be built using the Makefile in the documentation directory. Doxygen will generate HTML files.

cd doc/
Make

TODO

1. Support Windoze. I'll need to write wrappers for pthread.

License

The MIT License (MIT). Please see LICENSE for more information.

Examples

Send an email only every 10 seconds

#include <ens.h>

int main(int argc, char **argv) {
    ens_t *ens;

    ens = ens_init();
    ens_group_register(ens, 1);
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_MODE, ENS_GROUP_MODE_DROP);
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_HOST, "smtp.server.com:587");
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_FROM, "scott.newman50@gmail.com");
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_TO, "some.email@domain.com");
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_INTERVAL, 10);

    while (/** doing work **/) {
        if (/** some condition **/) {
            ens_group_send(ens, 1, "An error occured", "Some error happened and here's an email.");
        }
    }

Send an email only every 10 seconds. However, any email that was attempted to be sent before the timeout expires is queued and concatenated into one big email.

#include <ens.h>

int main(int argc, char **argv) {
    ens_t *ens;

    ens = ens_init();
    ens_group_register(ens, 1);
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_MODE, ENS_GROUP_OPTION_COLLECT);
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_HOST, "smtp.server.com:587");
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_FROM, "scott.newman50@gmail.com");
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_TO, "some.email@domain.com");
    ens_group_set_option(ens, 1, ENS_GROUP_OPTION_INTERVAL, 10);

    while (/** doing work **/) {
        if (/** some condition **/) {
            ens_group_send(ens, 1, "An error occured", "Some error happened and here's an email.");
        }
    }
	
    ens_free(ens);
    return 0;
}