package mrmime

  1. Overview
  2. Docs

Module Mrmime.HeaderSource

Sourcetype t

Type of the header.

Sourceval pp : Format.formatter -> t -> unit

Pretty-printer of pp.

Sourceval assoc : Field_name.t -> t -> Field.field list

assoc field_name header returns all values associated to field_name (several can exist into a header). It returns order, value and location if it comes from a source.

Sourceval remove_assoc : Field_name.t -> t -> t

remove_assoc field_name t removes all values associated to field_name.

Sourceval concat : t -> t -> t

concat t0 t1 concats t0 with t1 - any field-name existing in both are not deleted/replaced.

Sourceval exists : Field_name.t -> t -> bool

exists field_name t is true if field_name exists in t.

Sourceval add : Field_name.t -> ('a Field.t * 'a) -> t -> t

add field_name (w, v) t adds a new field-name with value v. add does not replace field_name if it already exists into t.

Sourceval add_unless_exists : Field_name.t -> ('a Field.t * 'a) -> t -> t

add_unless_exists field_name (w, v) t is a collection of header fields that is the same as t if t already includes field_name, and otherwise is equivalent to add field_name (w, v) t.

Sourceval replace : Field_name.t -> ('a Field.t * 'a) -> t -> t

replace field_name (w, v) t replaces existing field-name field_name in t by the new value v. If field_name does not exist, it adds it.

Sourceval of_list : Field.field list -> t

of_list l returns a header from the list l (without location).

Sourceval of_list_with_location : Field.field Location.with_location list -> t
Sourceval to_list_with_location : t -> Field.field Location.with_location list
Sourceval to_list : t -> Field.field list
Sourceval empty : t

empty is an empty header which does not have any default values.

Sourceval content_type : t -> Content_type.t

content_type header returns Content_type.t of the given header. If it does not exist, it returns Content_type.default.

Sourceval content_encoding : t -> Content_encoding.t

content_encoding header returns Content_encoding.t of the given header. If it does not exist, it returns Content_encoding.default.

Sourceval message_id : t -> MessageID.t option

message_id header returns a MessageID.t if it exists. Otherwise it returns None.

Sourceval length : t -> int

length hdr returns the length of the given header hdr.

Decoder of header.

Sourcemodule Decoder : sig ... end

Encoder of header.

Sourcemodule Encoder : sig ... end
Sourceval to_stream : t -> unit -> string option

to_stream header returns a stream of the given header which can be used into protocol like SMTP.