package mrmime

You can search for identifiers within the package.

in-package search v0.2.0

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
  - 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
mrmime.prettym
- Prettym
  - Buffer
  - IOVec

Legend:
Library
Module
Module type
Parameter
Class
Class type

An RFC 822 domain can be constructed in two ways. This construction differs from Address.domain. We can construct a common domain via:

let isomorphism = Domain.(v domain [ a "isomorphis"; a "me" ]) ;;
val isomorphism : domain = `Domain ["isomorphis"; "me"]
Domain.to_string isomorphism ;;
- : string = "isomorphis.me"

Or a literal domain:

let x25519 = Domain.(v literal "x25519") ;;
val x25519 : domain = `Literal "x25519"
Domain.to_string x25519 ;;
- : string = "[x25519]"

type atom = [

| `Atom of string

]

type literal = [

| `Literal of string

]

type 'a domain =

| :: : atom * 'a domain -> 'a Mrmime__.Peano.s domain
| [] : Mrmime__.Peano.z domain

type 'a t

Kind of domain according RFC 822.

An usual domain which is a non-empty list of atom elements
A `Literal domain which is a string surrounded by brackets.

val atom : string -> atom option

atom x returns a safe atom element. If x does not respect RFC 5322, it returns None. It accepts any characters excepts controls, space and specials characters - for instance, brackets are not allowed.

val atom_exn : string -> atom

Same as atom but raises an Invalid_argument instead None.

val a : string -> atom

Alias of atom_exn.

val literal : string -> literal option

literal x returns a literal domain. If x does not respect RFC 5321, it returns None. It will try to escape control characters (with escape_string).

val literal_exn : string -> literal

Same as literal but raises an Invalid_argument instead to return None.

val domain : 'a domain t

Kind of domain.

val default : string t

Kind of literal.

val make : 'a t -> 'a -> [ `Literal of string | `Domain of string list ] option

make kind v returns a safe domain. It can fail if an user-defined literal-domain (Literal_domain.extension), a literal domain or a domain don't follow standards:

for a literal, make returns None if literal returns None
for a domain, make returns None if list of atom is empty

val v : 'a t -> 'a -> [ `Literal of string | `Domain of string list ]

Same as make but raises an Invalid_argument instead None.

val to_string : [ `Literal of string | `Domain of string list ] -> string

to_string x returns a string which represents x as is it in a e-mails.