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

Legend:
Library
Module
Module type
Parameter
Class
Class type

A phrase in the context of the mailbox is a display-name that indicates the name of the recipient. We provide an easily way to make it and keep conformances according standards.

let name = Phrase.(v [ w "Daniel"; w "B" ]) ;;
val name : phrase
Phrase.to_string name ;;
- : string = "Daniel B"

About special encoding/charset, a `Word can store a valid UTF-8 string. Otherwise, you can use an Encoded_word.t to keep special characters:

let name = Phrase.(v [ w "Daniel"; e ~encoding:q "Bünzli" ]) ;;
- name : phrase
Phrase.to_string name ;;
- "Daniel =?UTF-8?Q?B=C3=BCnzli?=" : string

NOTE: we accept only valid UTF-8 contents. Other charset (like latin1) are NOT allowed - we can compute them but we choose to never produce them.

type elt = [

| `Dot
| `Word of Emile.word
| `Encoded of string * Emile.raw

]

type 'a t =

| [] : Mrmime__.Peano.z t
| :: : elt * 'a t -> 'a Mrmime__.Peano.s t
(*
Phrase, according RFC 5322, is a non-empty list of three elements (elt):
- `Dot a dot surrounded by space
- `Word w a word
- `Encoded e an encoded-word
*)

val o : elt

o produces a `Dot.

val w : string -> elt

w produces a safe word. w will try to escape control characters and verify if contents respects standards. Otherwise, w raises an Invalid_argument. `Word produced by w can be surrounded by double-quote.

val e : encoding:Encoded_word.encoding -> string -> elt

e is an alias of Encoded_word.make_exn. About `Encoded word, user can choose the way to encode the word. b for a Base64 encoding or q for a Quoted-Printable encoding. Both accept only UTF-8 contents - we don't accept any other charset.

val q : Encoded_word.encoding

Quoted-Printable encoding.

val b : Encoded_word.encoding

Base64 encoding.

val word : string -> (elt, [> Rresult.R.msg ]) Stdlib.result

word x tries to normalize x as a `Word according RFC 5322. It returns Error if x does not respect standards. If contents is an UTF-8 contents, word will surround x with double-quote and will escape control characters (see escape_string).

NOTE: UTF-8 is allowed in e-mails according RFC 6532.

val word_exn : string -> elt

Same as word but raises Invalid_argument instead to return Error.

val coerce : 'a Mrmime__.Peano.s t -> Emile.phrase

coerce l returns a valid and safe phrase.

val make : 'a t -> (Emile.phrase, [> Rresult.R.msg ]) Stdlib.result

make l returns a phrase only if l is a non-empty list.

val v : 'a t -> Emile.phrase

Same as make but raises an exception instead to return Error.

val to_string : Emile.phrase -> string

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