package mrmime

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Equals.
Pretty-printers.
Encoder of address.
Unstructured cast.

package mrmime

mrmime
- Mrmime
  - Address
    
    Encoder
  - Content
    
    Encoder
  - Content_encoding
    
    Encoder
  - Content_field
  - Content_type
    
    Encoder
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Date
    
    Day
    
    Encoder
    
    Month
    
    Zone
  - Encoded_word
    
    Encoder
  - Field
    
    Encoder
  - Field_name
    
    Encoder
  - Group
    
    Encoder
  - Hd
    
    Refl
    
    Value
  - Header
    
    Encoder
  - Iana
    
    Map
    
    Set
  - Location
  - Mail
  - Mailbox
    
    Domain
    
    Encoder
    
    Literal_domain
    
    Local
    
    Phrase
  - MessageID
    
    Domain
    
    Encoder
  - Mt
  - Option
  - Resent
    
    Encoder
  - Rfc2045
  - Rfc2047
  - Rfc5321
  - Rfc5322
  - Rfc6532
  - Rfc822
  - Trace
    
    Encoder
  - Unstructured
    
    Encoder
  - Utils
mrmime.butils
- Butils
mrmime.encoder
- Encoder
  - Buffer
  - IOVec

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = [

| `Group of Group.t
| `Mailbox of Mailbox.t

]

Type of address, an address may either be an individual mailbox, or a group of mailboxes.

val group : Group.t -> t

group g returns an address from a Group.t.

val mailbox : Mailbox.t -> t

mailbox m returns an address from a Mailbox.t.

Equals.

val equal : t -> t -> bool

Equal function of t.

Pretty-printers.

val pp : t Fmt.t

Pretty-printer of t.

Encoder of address.

module Encoder : sig ... end

Unstructured cast.

val addresses_to_unstructured : 
  field_name:Field_name.t ->
  t list ->
  Unstructured.t

addresses_to_unstructured ~field_name addresses map a list of addresses to an Unstructured.t value. Should never fail - in this case, it raises a Failure.

val to_unstructured : field_name:Field_name.t -> t -> Unstructured.t

to_unstructured ~field_name t map an address (eg. t) to an Unstructured.t value. Should never fail - in this case, it raises a Failure.