package mrmime

You can search for identifiers within the package.

in-package search v0.2.0

mrmime
- Library mrmime
  - Mrmime
    
    Iana
    
    Map
    
    Set
    
    Location
    
    Content_encoding
    
    Decoder
    
    Encoder
    
    MessageID
    
    Domain
    
    Decoder
    
    Encoder
    
    Content_type
    
    Type
    
    Subtype
    
    Parameters
    
    Map
    
    Decoder
    
    Encoder
    
    Encoded_word
    
    Decoder
    
    Encoder
    
    Mailbox
    
    Phrase
    
    Literal_domain
    
    Domain
    
    Local
    
    Decoder
    
    Encoder
    
    Date
    
    Day
    
    Month
    
    Zone
    
    Decoder
    
    Encoder
    
    Field
    
    Decoder
    
    Encoder
    
    Field_name
    
    Decoder
    
    Encoder
    
    Map
    
    Header
    
    Decoder
    
    Encoder
    
    Address
    
    Decoder
    
    Encoder
    
    Group
    
    Phrase
    
    Decoder
    
    Encoder
    
    Unstructured
    
    Decoder
    
    Craft
    
    Encoder
    
    Mail
    
    Hd
    
    Mt
- Sources
  - mrmime
    
    address.ml
    
    b64.ml
    
    content_encoding.ml
    
    content_type.ml
    
    date.ml
    
    encoded_word.ml
    
    field.ml
    
    field_name.ml
    
    group.ml
    
    hd.ml
    
    header.ml
    
    iana.ml
    
    location.ml
    
    mail.ml
    
    mailbox.ml
    
    messageID.ml
    
    mrmime.ml
    
    mrmime__.ml
    
    mt.ml
    
    option.ml
    
    peano.ml
    
    quoted_printable.ml
    
    rfc2046.ml
    
    unstructured.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `MessageID.Domain`Source

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]"

Sourcetype atom = [

| `Atom of string

]

Sourcetype literal = [

| `Literal of string

]

Sourcetype 'a domain =

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

Sourcetype '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.

Sourceval 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.

Sourceval atom_exn : string -> atom

Same as atom but raises an Invalid_argument instead None.

Sourceval a : string -> atom

Alias of atom_exn.

Sourceval 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).

Sourceval literal_exn : string -> literal

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

Sourceval domain : 'a domain t

Kind of domain.

Sourceval default : string t

Kind of literal.

Sourceval 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

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

Same as make but raises an Invalid_argument instead None.

Sourceval 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.

package mrmime

Module MessageID.DomainSource

Module `MessageID.Domain`Source