package mrmime

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Constructors.
Pretty-printers.
Equals & compares.
Decoder of date.
Encoder of date.

package mrmime

mrmime
- Mrmime
  - Address
    
    Decoder
    
    Encoder
  - Content_encoding
    
    Decoder
    
    Encoder
  - Content_type
    
    Decoder
    
    Encoder
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Date
    
    Day
    
    Decoder
    
    Encoder
    
    Month
    
    Zone
  - Encoded_word
    
    Decoder
    
    Encoder
  - Field
    
    Decoder
    
    Encoder
  - Field_name
    
    Decoder
    
    Encoder
    
    Map
  - Group
    
    Decoder
    
    Encoder
    
    Phrase
  - Hd
  - Header
    
    Decoder
    
    Encoder
  - Iana
    
    Map
    
    Set
  - Location
  - Mail
  - Mailbox
    
    Decoder
    
    Domain
    
    Encoder
    
    Literal_domain
    
    Local
    
    Phrase
  - MessageID
    
    Decoder
    
    Domain
    
    Encoder
  - Mt
  - Unstructured
    
    Craft
    
    Decoder
    
    Encoder

Legend:
Library
Module
Module type
Parameter
Class
Class type

module Day : sig ... end

module Month : sig ... end

module Zone : sig ... end

type t = {

day : Day.t option;
date : int * Month.t * int;
time : int * int * int option;
zone : Zone.t;

}

Type of date according RFC 822 / RFC 2822 / RFC 5322.

Constructors.

val make : 
  ?day:Day.t ->
  (int * Month.t * int) ->
  (int * int * int option) ->
  Zone.t ->
  (t, [> `Msg of string ]) result

make ?day (year, month, day) (hh, mm, ss) tz returns a date corresponding to month/day/year hh:mm:ss date-time with time zone tz. ?day (which is the day in the 7-day week) and day must correspond according of timestamp to month/day/year and time zone tz. If it's not the case, make returns an error.

(year, month, day) (hh, mm, ss) must correspond to a valid POSIX timestamp. The date-time must be in the range of 0000-01-01 00:00:00 UTC and 9999-12-31 23:59:59.99 UTC. Otherwise, make returns an error.

If ss = None, seconds are 0. If ?day = None, it will be the day in the 7-day week of POSIX timestamp corresponding to date-time (year, month, day) (hh, mm, ss) expressed in the time zone offset tz.

make relies on Ptime.of_date_time. To completely understand implication of that, you should read basics about ptime.

val to_ptime : t -> (Ptime.t * int, [> `Msg of string ]) result

to_ptime t returns a POSIX timestamp Ptime.t.

val of_ptime : zone:Zone.t -> Ptime.t -> t

of_ptime ~zone t is date-time t of POSIX timestamp t. zone hints the time zone offset used for the resulting daytime Day.t component.

Pretty-printers.

val pp : Format.formatter -> t -> unit

Equals & compares.

val equal : t -> t -> bool

val compare : t -> t -> int

Decoder of date.

module Decoder : sig ... end

Encoder of date.

module Encoder : sig ... end