Schemas for the email Superservice
Prev | Chapter 6. Schemas Reference | Next

## Schemas for the email Superservice

### DLF Schema for Email service

Schema ID: `email`

Timestamp Field: `time`

The email DLF schema represents delivery done by an mail transfer agent between one one recipient. Each DLF record contains the information related to the process of delivering between one sender and one recipient. Each exchange between one sender and one recipient will results in one and only one DLF record. If one sender is sending to multiple recipients, the DLF file should contains one record for each recipient.

### Warning

This DLF schema is different from the other ones because it contains pre-analysed data. It is currently in redesign and will become something that will more closely resemble what you can usually find in an email log file. Different information for each phase of the mail delivery process.

That schema will probably become a derived schema from the new base schema.

Fields in the Schema

`time`

  Type: timestamp

  Defaults: 0

  The time of the first event regarding that delivery. That should be the time the email enter the delivery process.

`logrelay`

  Type: hostname

  Defaults: -

  The hostname on which the MTA is running.

  ### Warning

  That original intent of that field was to analyse email servers' farm which used syslog to centralize their logs. This method of analysis for multiple servers was never actually used and is considerd obsolete.

`queueid`

  Type: string

  Defaults: -

  The queue identifier. This should be the identifier that can be used to reconstitute the delivery process from the native log file regarding the delivery that this DLF record represents.

`msgid`

  Type: string

  Defaults: -

  The content of the Message-ID header of the delivered message.

`from_user`

  Type: string

  Defaults: -

  The local part of the sender's email address.

`from_domain`

  Type: hostname

  Defaults: -

  The hostname of the sender's email address.

`from_relay_host`

  Type: hostname

  Defaults: -

  The hostname from which the email was received. For email submitted via the sendmail interface or other similar mechanism, this should be `localhost`.

`from_relay_ip`

  Type: ip

  Defaults: -

  The ip address from which the email was received. For email submitted via the sendmail interface or other similar mechanism, this should be `127.0.0.1`.

`size`

  Type: bytes

  Defaults: 0

  The size of the message.

`delay`

  Type: duration

  Defaults: 0

  The time that it took to deliver the message. This should be equivalent to the time of the delivery event minus the value of the `time` field.

`xdelay`

  Type: duration

  Defaults: 0

  ### Warning

  This field was never actually used and is obsolete.

`to_user`

  Type: string

  Defaults: -

  The local part of the recipient's email address.

`to_domain`

  Type: hostname

  Defaults: -

  The hostname of the recipient's email address.

`to_relay_host`

  Type: hostname

  Defaults: -

  The hostname to which the email was delivered. If the recipient is a local user and this was the "final" delivery, this should be `localhost`.

`to_relay_ip`

  Type: ip

  Defaults: -

  The ip address to which the email was delivered. If the recipient is a local user and this was the "final" delivery, this should be `127.0.0.1`.

`stat`

  Type: string

  Defaults: -

  The status code of the delivery. Only standardized code are `sent` which is used when the delivery succeeded without error and `deferred` for when the email still wasn't delivered at the end of the log file. Other values are specific to each service.

`xstat`

  Type: string

  Defaults: -

  The complete native status message related to the email's delivery.

### Extended Schemas for the email Superservice

#### Email Extended Schema for Email service

Schema ID: `email-email`

Base Schema: `email`

Module: `Lire::Extensions::Email::EmailSchema`

Required Fields: from_user, from_domain, to_user, to_domain

This is an extended schema for the Email service which adds fields containing the complete email.

Fields in the Schema

`from_email`

  Type: email

  Defaults: -

  The sender's email address. That value is the `from_user` joined to the `from_domain` by an `@`.

`to_email`

  Type: email

  Defaults: -

  The recipient's email address. That value is the `to_user` joined to the `to_domain` by an `@`.

Prev | Up | Next
Schemas for the dnszone Superservice | Home | Schemas for the firewall Superservice