Manual Reference Pages  - libomnibiff (3)

NAME

libomnibiff - OmniBiff API

CONTENTS

Synopsis
Description
Return Value

SYNOPSIS

#include <omni.h>

int getNumberOfBifflets();

int getCurrentStatus(int *num_bifflets, bifflet *states);

void enable(char *name);

void disable(char *name);

DESCRIPTION

getNumberOfBifflets returns the number of mailboxes being monitored by OmniBiff, or -1 if OmniBiff cannot be contacted.

getCurrentStatus obtains status for all mailboxes. num_bifflets is the number of elements in states. If OmniBiff is currently monitoring a different number of mailboxes, this will be set accordingly upon return. However, no more than num_bifflets elements in states will be set in any case. The status for each each mailbox is as follows:
0 uninitialized
1 uninitialized, active
2 new mail
3 new mail, active
4 unable to contact email server
5 unable to contact email server, active
6 no new mail
7 no new mail, active

The "active" states indicate that OmiBiff is actively (re)checking the server.

enable and disable will resume and suspend checking on name, respectively.

RETURN VALUE

getNumberOfBifflets and getCurrentStatus return -1 if OmniBiff cannot be contacted.

AUTHOR

Jason Lowdermilk <lowdermilk@users.sourceforge.net>

COPYRIGHT

libomnibiff is Copyright (c) 2001 by Jason Lowdermilk. libomnibiff and OmniBiff are free software under the conditions of the GNU General Public License.


libomnibiff (3) March 2001
Generated by manServer 1.07 from libomnibiff.3 using man macros.