Index of values

p *> q runs p, discards its result and then runs q.

p <* q runs p, then runs q, discards its result, and returns the result of p.

f <$> p is equivalent to p >>| f.

f <*> p is equivalent to f >>= fun f -> p >>| f.

p <|> q runs p and returns the result if succeeds.

p >>= f creates a parser that will run p, pass its result to f, run the parser that f produces, and return its result.

p >>| f creates a parser that will run p, and if it succeeds with result v, will return f v.

advance n advances the input of n bytes.

char c accepts c and return it.

count n p runs p n times, returning a list of the results.

create_bigstring size returns a fresh input of length size with the proof MrMime_input.bs.

create_bytes size returns a fresh input of length size with the proof MrMime_input.st.

decode boundary rollback decodes a Base64 input and stops at the boundary and, iff the decoder recognizes the boundary, it rollbacks - that means the input contains the boundary although it recognized.

decode decoder is: `Continue if decoder awaits for more input. The client must use MrMime_base64.src to provide it., `Dirty s if decoder has a padding error or if the character is not a valid Base64 character (see is_b64). If the client is interested in a best-effort decoding it can still continue to decode after an dirty chunk., `Error exn if decoder has a padding error (Wrong_padding error) - in this case, the client doest not trust the content - or a parsing error., `String s if a chunk s was decoded., `End s if the last chunk s was decoded - when the decoder arises one time this value, it returns only this value after the client recall decode.

decode boundary rollback decodes a QuotedPrintable input and stops at the boundary and, iff he decoder recognizes the boundary, it rollbacks - that means the input contains the boundary although it recognized.

decode decoder is: `Continue if decoder awaits for more input. The client muse use MrMime_quotedPrintable.src to provide it., `Dirty chr if decoder recognizes an unsafe character (according RFC2045:

    safe-char := <any octet with decimal value of 33 through
                 60 inclusive, and 62 through 126>
                 ; Characters not listed as "mail-safe" in
                 ; RFC2049 are also not recommended.
    

decoder (boundary, rollback) input is a Base64 decoder that inputs from input.

decoder (boundary, rollback) input is a QuotedPrintable decoder that inputs from input.

decoder_src decoder is decoder's input source.

decoder_src decoder is decoder's input source.

According to MrMime_contentType.default, MrMime_contentEncoding.default and MrMime_mimeVersion.default, we have a default value of a content header.

Default RFC822 messages without a MIME "Content-Type" header are taken by this protocol to be plain text in the US-ASCII character set, which can be excplicitly specified as:

An encoding type of `Bit7 requires that the body is already in a `Bit7 mail-ready representation.

Default value of version.

equal a b is true iff a and b are the same date.

fail exn creates a parser that will always fail with the MrMime_parser.err exn.

fix f computes the fixpoint of f and runs the resultant parser.

get input gets the first character at the read pointer.

Corresponding to the rule from RFC2045 about the hexadecimal value:

inline () decodes an inline encoded string.

inline () decodes an inline encoded string.

is_b64 chr returns true iff the character is a Base64 character.

is_hex chr returns true iff the character is a hexadecimal character.

The liftN family of functions promote functions to the parser monad.

list ps runs each p in ps in sequence, returning a list of results of each p.

many p runs p zero or more times and returns a list of results from the runs of p.

See RFC2045 § 3:

of_string ~chunk:1024 buf parses an RFC2045 MrMime_contentType.content starting at 0 in buf:

of_string ~chunk:1024 buf parses an RFC2045 MrMime_contentEncoding.mechanism starting at 0 in buf.

of_string ~chunk:1024 buf parses an RFC2045 MrMime_mimeVersion.version starting at 0 in buf.

of_string ~chunk:1024 buf parses an RFC5322 message ID starting at 0 in buf.

of_string ~chunk:1024 buf parses an RFC5322 date starting at 0 in buf.

of_string_raw ~chunk:1024 buff off len parses an RFC2045 MrMime_contentType.content starting at off in buf to a tuple (content, count)i with:

of_string_raw ~chunk:1024 buff off len parses an RFC2045 MrMime_contentEncoding.mechanism starting at off in buf to a tuple (mechanism, count) with: mechanism the MrMime_contentEncoding.mechanism, count the number of bytes read starting at off to parse the mechanism. This function allocates a internal buffer with chunk size (default to 1024).

of_string_raw ~chunk:1024 buff off len parses an RFC2045 MrMime_mimeVersion.version starting at off in buf to a tuple (version, count) with:

of_string_raw ~chunk:1024 buf off len parses an RFC5322 message ID starting at off in buf to a tuple (msg_id, count) with;

of_string_raw ~chunk:1024 buf off len parses an RFC5322 date starting at off in buf to a tuple (date, count) with: date the date, count the number of bytes read starting at off to parse the date. This function allocates a internal buffer with chunk size (default to 1024).

one p runs p one or more times and returns a list of results from the runs of p.

only input p runs p on input.

option v p runs p, returning the result of p if it succeeds and v if it fails.

See RFC2045 § 5.1:

See RFC5322 § 3.3:

See RFC5322 § 3.3:

See RFC5322 § 3.3 & 4.3:

See RFC5322 § 3.3 & 4.3:

See RFC2045 § 6.1:

See RFC5322 § 3.3 & 4.3:

See RFC5322 § 3.3 & 4.3:

See RFC5322 § 3.3:

See RFC5322 § 3.6.4 and RFC822 4.1:

See RFC5322 § 3.3 & 4.3:

See RFC5322 § 3.3:

See RFC2045 § 4:

See RFC5322 § 3.3 & 4.3:

See RFC5322 § 3.3 & 4.3:

See RFC2045 § 3:

peek input buf off len same as MrMime_input.read but does not advance the read pointer.

peek_chr accepts any char and return it, or returns None if the end of input has been reached.

peek_chr_exn accepts any char and returnss it.

pp content prints an human readable representation of MrMime_content.t.

pp content prints an human readable representation of MrMime_contentType.content.

pp mechanism prints an human readable representation of mechanism.

pp version prints an human readable representation of version.

pp fmt msg_id prints an human readable representation of msg_id.

pp date prints an human readable representatation of date.

pp input prints an human readable representation of input.

pp_day prints an human readable representation of day.

pp_domain fmt local prints an human readable representation of the right-hand side of the "@".

pp_field field prints an human readable representation of MrMime_content.field.

pp_local fmt local prints an human readable representation of the left-hand side of the "@".

pp_month prints an human readable representation of month.

pp_value (attribute, value) prints an human readable representation of parameter.

pp_raw raw prints an human readable representation of MrMime_content.raw.

pp_subty subty prints an human readable representation of MrMime_contentType.subty.

pp_ty ty prints an human readable representation of MrMime_contentType.ty.

pp_unstructured v prints an human readable representation of MrMime_content.unstructured.

pp_value value prints an human readable representation of MrMime_contentType.value.

pp_zone prints an human readable representation of zone.

proof input gets the internal buffer with the proof.

radvance input n drops n bytes.

ravailable input returns available bytes to read.

read input buf off len read the data inside the input and advance the read pointer.

read_space input returns a continuous part of the internal buffer with the offset and the length of bytes available to read.

recognize f accepts input as long as f returns true and returns the accepted characters as a string.

repeat a b f is a parser from the RFC5234 to recognize any character which respect the predicate f.

return v creates a parser that will always succeed and return v.

run input p runs p on input.

satisfy f accepts any character for which f returns true and returns the accepted character.

savailable input returns available bytes to read or, if the input is committed, returns available bytes from the commit to the write pointer.

size input returns the length of the given input.

src decoder buf off len provides decoder with len bytes to read, starting at off in buf.

src decoder buf off len provides decoder with len bytes to read, starting at off in buf.

store buf f stores any character for which f returns true in buf only on the continuous buffer inside the input.

string f s ensures the input has String.length s (in another case, the parser fails with End_of_flow) and compare the string s' from the input and s with f s = f s' (in another case, the parser fails with MrMime_parser.String).

take n accepts exactly n character(s) of input and returns them as a string.

to_string date formats the date date accoding to a RFC5322.

transmit input f same as Option.map f (read_space input).

wadvance input n advances the write pointer.

wavailable input returns available bytes to write.

write input buf off len writes an internal buffer (with the same proof 'a - see MrMime_input.st or MrMime_input.bs) starting at off to len inside the input.

write_space input returns a continuous part of the internal buffer with the offset and the length of bytes available to write.

write_string input buf off len writes a string starting at off to len inside the input.