Module `Received`Source

Received field

Sourcetype t

Type of Received value.

Sourceval compare : t -> t -> int

Sourceval equal : t -> t -> bool

Sourcetype 'a with_info =

| Only of 'a
| With of 'a * info

Sourceand info = [

| `Address of Colombe.Domain.t
| `Domain_and_address of Colombe.Domain.t * Colombe.Domain.t

]

Sourceval received_by : t -> Colombe.Domain.t with_info option

Sourceval received_from : t -> Colombe.Domain.t with_info option

Sourceval received_for : t -> Colombe.Path.t option

Sourcetype link = private [

| `TCP
| `Atom of string

]

Type of underlying protocol used to receive email.

Sourcetype protocol = private [

| `ESMTP
| `SMTP
| `Atom of string

]

Type of protocol used to receive email:

SMTP
ESMTP
Other protocol

Sourceval received_with : t -> protocol option

Sourceval received_via : t -> link option

Source

val id : 
  t ->
  [ `Local of Emile.local | `MsgID of Mrmime.MessageID.t | `Atom of string ]
    option

Sourceval date_time : t -> Mrmime.Date.t

Sourcetype 'a stream = unit -> 'a option

Sourceval tcp : link

Sourceval link : string -> link

Sourceval smtp : protocol

Sourceval esmtp : protocol

Sourceval protocol : string -> protocol

Source

val make : 
  ?from:Colombe.Domain.t with_info ->
  ?by:Colombe.Domain.t with_info ->
  ?via:link ->
  ?protocol:protocol ->
  ?id:Mrmime.MessageID.t ->
  Colombe.Path.t option ->
  zone:Mrmime.Date.Zone.t ->
  Ptime.t ->
  t

make ?from ?by ?via ?protocol ?id path ~zone time:

from is the domain where the email comes from.
by is the domain where the email is received.
via is the underlying protocol used to receive the email (usually tcp).
protocol is the protocol used to receive the email.
id is the chosen ID by the MTA.
path is the given Path.t received by the MTA
zone is the time-zone of the MTA.
time is the time when the MTA received the email.

Sourceval pp : t Fmt.t

Sourcemodule Decoder : sig ... end

Sourcemodule Encoder : sig ... end

Source

val of_stream : 
  (string * int * int) stream ->
  (string * t list, [> `Msg of string ]) result

package received

Module ReceivedSource

Module `Received`Source