package received

  1. Overview
  2. Docs

Module ReceivedSource

Received field

Sourcetype t

Type of Received value.

Sourceval compare : t -> t -> int
Sourceval equal : t -> t -> bool
Sourcetype 'a with_info =
  1. | Only of 'a
  2. | With of 'a * info
Sourceand info = [
  1. | `Address of Colombe.Domain.t
  2. | `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

Type of underlying protocol used to receive email.

Sourcetype protocol = private [
  1. | `ESMTP
  2. | `SMTP
  3. | `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
Sourceval 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 smtp : protocol
Sourceval esmtp : protocol
Sourceval protocol : string -> protocol
Sourceval 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
Sourceval of_stream : (string * int * int) stream -> (string * t list, [> `Msg of string ]) result