@cull/pore
Version:
An email data analysis library.
37 lines (36 loc) • 878 B
TypeScript
import { Moment } from 'moment';
import Client, { Envelope, Mailbox } from '@cull/imap';
import Identity from './identity';
/**
* Analytical primative translated from email metadata.
*/
export default class Datum {
/**
* Originating IMAP client
*/
client: Client;
/**
* Originating Mailbox
*/
mailbox: Mailbox;
/**
* Originating email envelope
*/
envelope: Envelope;
/**
* A datetime object representing when the message was received
*/
moment: Moment;
/**
* From
*/
from: Identity[];
/**
* Datum constructor
*
* @param envelope original envelope to transform
* @todo investigate reliance on envelope date field
* @todo verify date format to guarantee for parsing reliability
*/
constructor(client: Client, mailbox: Mailbox, envelope: Envelope);
}