dmail.schema

Go to the documentation of this file.

<?php
// $Id: 0196f0d5924a03222a8977f84dbefaccad54d7fd $
function dmail_schema_0() {
  $schema['dmail_identities'] = dmail_identities_table();
  $schema['dmail_mboxes'] = dmail_mboxes_table();
  $schema['dmail_vmboxes'] = dmail_vmboxes_table();
  $schema['dmail_message_headers'] = dmail_message_headers_table();
  $schema['dmail_mbox_message_headers'] = dmail_mbox_message_headers_table();
  $schema['dmail_vheaders'] = dmail_vheaders_table();
  $schema['dmail_junk_messages'] = dmail_junk_messages_table();
  $schema['dmail_headerinfo'] = dmail_headerinfo_table();
  $schema['dmail_mailaddresses'] = dmail_mailaddresses_table();
  $schema['dmail_friends'] = dmail_friends_table();
  $schema['dmail_addrmap'] = dmail_addrmap_table();
  $schema['dmail_signatures'] = dmail_signatures_table();
  return $schema;
}

function dmail_identities_table() {
  return array(
    'description' => 'User defined imap, pop3, or nntp identities.',
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'description' => 'The primary serial key to identify this record.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'user_id' => array(
        'type' => 'int',
        'description' => 'The uid that created this record.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'signature_id' => array(
        'type' => int,
        'description' => 'The user selected signature for this identity.  If 0 then none has been selected.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'name' => array(
        'type' => 'varchar',
        'description' => 'The user desired display name for this identity.',
        'not null' => TRUE,
        'length' => 255,
      ),
      'created' => array(
        'type' => 'datetime',
        'description' => 'The date and time this record was created.',
        'not null' => TRUE,
        'default' => 0,
      ),
      'lastchkd' => array(
        'type' => 'datetime',
        'description' => 'The date and time we last check this accounts mail.',
        'not null' => TRUE,
        'default' => 0,
      ),
      'user' => array(
        'type' => 'varchar',
        'description' => 'The users email account login id.',
        'length' => 255,
        'default' => 'UNKNOWN',
        'not null' => TRUE,
      ),
      'pass' => array(
        'type' => 'varchar',
        'description' => 'The decipherable encrypted users password.',
        'length' => 255,
        'default' => 'UNKNOWN',
        'not null' => TRUE,
      ),
      'host' => array(
        'type' => 'varchar',
        'description' => 'The hostname for the service.',
        'length' => 255,
        'default' => 'localhost',
        'not null' => TRUE,
      ),
      'service' => array(
        'type' => 'char',
        'description' => 'The type of service (imap, pop3, nntp).',
        'length' => 4,
        'default' => 'imap',
        'not null' => TRUE,
      ),
      'port' => array(
        'type' => 'int',
        'description' => 'The port the service communicates on.',
        'size' => 'small',
        'default' => 143,
        'not null' => TRUE,
      ),
      'inbox' => array(
        'type' => 'varchar',
        'description' => 'The inbox mailbox such as INBOX.',
        'length' => 255,
        'default' => 'INBOX',
        'not null' => TRUE,
      ),
      'delimiter' => array(
        'type' => 'char',
        'description' => 'The mailbox folder delimiter.',
        'length' => 1,
        'default' => '.',
        'not null' => TRUE,
      ),
      'toplevel' => array(
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
      'orderby' => array(
        'type' => 'char',
        'length' => '8',
        'default' => 'received',
        'not null' => TRUE,
      ),
      'sortdir' => array(
        'type' => 'char',
        'length' => '4',
        'default' => 'desc',
        'not null' => TRUE,
      ),
      'encryption' => array(
        'type' => 'char',
        'description' => 'The type of encryption (none, tls, ssl).',
        'length' => 4,
        'default' => 'none',
        'not null' => TRUE,
      ),
      'vld8cert' => array(
        'type' => 'int',
        'description' => 'Validate service security certificates?',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
      'expunge' => array(
        'type' => 'int',
        'description' => 'Permanently removed the items flagged as deleted when service resource is closed?',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
      'readonly' => array(
        'type' => 'int',
        'description' => 'Open the mailbox for read only access. Normally used for debugging.',
        'size' => 'tiny',
        'default' => 1,
        'not null' => TRUE,
      ),
      'movedel' => array(
        'type' => 'int',
        'description' => 'Move items flagged as deleted to the deleted folder?',
        'size' => 'tiny',
        'default' => 1,
        'not null' => TRUE,
      ),
      'checkevery' => array(
        'type' => 'int',
        'description' => 'Check for new mail every X seconds.',
        'size' => 'small',
        'default' => 600,
        'not null' => TRUE,
      ),
      'smtpport' => array(
        'type' => 'int',
        'description' => 'The port for the SMTP service on the smtphost.',
        'size' => 'small',
        'default' => 25,
        'not null' => TRUE,
      ),
      'sanitizedeleted' => array(
        'type' => 'int',
        'description' => 'When movedel is set make sure deleted mail is actually in the specified delete folder?',
        'size' => 'tiny',
        'default' => 1,
        'not null' => TRUE,
      ),
      'deletefolder' => array(
        'type' => 'varchar',
        'description' => 'The name of the folder to store deleted mail.',
        'length' => 255,
      ),
      'draftfolder' => array(
        'type' => 'varchar',
        'description' => 'The name of the folder to store draft mail.',
        'length' => 255,
      ),
      'sentfolder' => array(
        'type' => 'varchar',
        'description' => 'The name of the folder to store sent copies.',
        'length' => 255,
      ),
      'junkfolder' => array(
        'type' => 'varchar',
        'description' => 'The name of the folder to store junk (a.k.a. SPAM) mail.',
        'length' => 255,
      ),
      'messages' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
      ),
      'recent' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('id'),
    'unique keys' => array(
      'name' => array('name', 'user_id'),
      'user' => array('user', 'user_id'),
    ),
    'indexes' => array(
      'user_id' => array('user_id'),
      'signature_id' => array('signature_id'),
    ),
  );
}

function dmail_mboxes_table() {
  return array(
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'identity_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'name' => array(
        'type' => 'text',
        'not null' => TRUE,
      ),
      'created' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0
      ),
      'lastchkd' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0,
      ),
      'attributes' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
      ),
      'flags' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
      ),
      'messages' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
      ),
      'recent' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
      ),
      'unseen' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
      ),
    ),
    'primary key' => array('id'),
  );
}

function dmail_vmboxes_table() {
  return array(
    'description' => 'Virtual mail boxes',
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'mbox_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('id'),
    'unique keys' => array(
      'name' => array('mbox_id', 'name'),
    ),
  );
}

function dmail_message_headers_table() {
  return array(
    'fields' => array(
      'msgid' => array(
        'type' => 'char',
        'length' => 64,
        'description' => 'The md5 of the message_id.',
        'not null' => TRUE,
      ),
      'subject' => array(
        'type' => 'varchar',
        'length' => 1024,
      ),
      're' => array(
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
        'unsigned' => TRUE,
      ),
      'from' => array(
        'type' => 'varchar',
        'length' => 1024,
      ),
      'to' => array(
        'type' => 'varchar',
        'length' => 1024,
      ),
      'date' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0,
      ),
      'message_id' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'size' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'created' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0,
      ),
      'updated' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('msgid'),
    'indexes' => array(
      'date' => array('date'),
      'created' => array('created'),
      'updated' => array('updated'),
      'subject' => array('subject'),
    ),
  );
}

function dmail_mbox_message_headers_table() {
  return array(
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'mbox_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'msgid' => array(
        'type' => 'char',
        'length' => 64,
        'description' => 'The md5 of the from and the md5 of the message_id.',
        'not null' => TRUE,
      ),
      'uid' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'msgno' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'recent' => array(
        'type' => 'int',
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'flagged' => array(
        'type' => 'int',
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'answered' => array(
        'type' => 'int',
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'deleted' => array(
        'type' => 'int',
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'seen' => array(
        'type' => 'int',
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'draft' => array(
        'type' => 'int',
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 0,
      ),
      'display' => array(
        'type' => int,
        'size' => 'tiny',
        'unsigned' => TRUE,
        'default' => 1,
      ),
      'created' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0,
      ),
      'updated' => array(
        'type' => 'datetime',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('id'),
    'unique key' => array('mbox_id' => array('mbox_id', 'msgid')),
    'indexes' => array(
      'msgid' => array('msgid'),
      'uid' => array('uid'),
      'msgno' => array('msgno'),
      'recent' => array('recent'),
      'flagged' => array('flagged'),
      'deleted' => array('deleted'),
      'display' => array('display'),
      'created' => array('created'),
      'updated' => array('updated'),
    ),
  );
}

function dmail_vheaders_table() {
  return array(
    'description' => 'Virtual mail headers',
    'fields' => array(
      'vmbox_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'header_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('vmbox_id', 'header_id'),
  );
}

function dmail_junk_messages_table() {
  return array(
    'description' => 'Junk messages controller.',
    'fields' => array(
      'user_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'msgid' => array(
        'type' => 'char',
        'length' => 64,
        'description' => 'A unique identifier for the message.',
        'not null' => TRUE,
      ),
    ),
    'primary_key' => array('user_id', 'msgid'),
  );
}

function dmail_headerinfo_table() {
  return array(
    'description' => 'Store the imap headerinfo information.',
    'fields' => array(
      'msgid' => array(
        'description' => 'Unique identifier for an individual mail',
        'type' => 'char',
        'length' => 64,
        'not null' => TRUE,
      ),
      'headers' => array(
        'type' => 'blob',
        'size' => 'big',
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('msgid'),
  );
}

function dmail_mailaddresses_table() {
  return array(
    'description' => 'Store the email addresses from the mail item headers',
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'mbox_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'user' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'host' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'personal' => array(
        'type' => 'varchar',
        'length' => 255,
      ),
    ),
    'primary key' => array('id'),
    'unique keys' => array(
      'user' => array('mbox_id', 'user', 'host'),
    ),
  );
}

function dmail_friends_table() {
  return array(
    'description' => 'Allow the user to identify friendly email addresses.',
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'user_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'mailaddress_id' => array(
        'type' => 'int',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'nickname' => array(
        'type' => 'varchar',
        'length' => 255,
      ),
    ),
    'primary key' => array('id'),
    'unique keys' => array(
      'address' => array('user_id', 'mailaddress_id'),
    ),
  );
}

function dmail_addrmap_table() {
  return array(
    'description' => 'Map a preferred From address for a given To address',
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'description' => 'The primary serial key to identify this record.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'user_id' => array(
        'type' => 'int',
        'description' => 'The uid that created this record.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'address' => array(
        'type' => 'varchar',
        'description' => 'The To address to map.',
        'not null' => TRUE,
        'length' => 255,
      ),
      'preferred' => array(
        'type' => 'varchar',
        'description' => 'The mapped From address.',
        'not null' => TRUE,
        'length' => 255,
      ),
    ),
    'primary key' => array('id'),
    'unique keys' => array(
      'address' => array('user_id', 'address'),
    ),
  );
}

function dmail_signatures_table() {
  return array(
    'description' => 'The user defined signatures.',
    'fields' => array(
      'id' => array(
        'type' => 'serial',
        'description' => 'The primary serial key to identify this record.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'user_id' => array(
        'type' => 'int',
        'description' => 'The uid that created this record.',
        'size' => 'big',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'name' => array(
        'type' => 'varchar',
        'description' => 'The user desired display name for this signature.',
        'not null' => TRUE,
        'length' => 255,
      ),
      'created' => array(
        'type' => 'datetime',
        'description' => 'The date and time this record was created.',
        'not null' => TRUE,
        'default' => 0,
      ),
      'updated' => array(
        'type' => 'datetime',
        'description' => 'The date and time this record was updated.',
        'not null' => TRUE,
        'default' => 0,
      ),
      'signature' => array(
        'type' => 'text',
        'description' => 'The signature value.',
        'size' => 'tiny',
      ),
    ),
    'primary key' => array('id'),
    'unique indexes' => array(
      'name' => array('user_id', 'name'),
    ),
  );
}