Module Netascii_armorSource

Messages with ASCII armor

There are various forms of ASCII-armored messages:

Sourcetype armor_type = [
  1. | `Plain
  2. | `Base64
  3. | `OpenPGP
]
Sourcetype armored_message = [
  1. | `Plain of Netmime.mime_body
  2. | `Base64 of Netmime.mime_body
  3. | `OpenPGP of Netmime.mime_header * Netmime.mime_body * int
]

Messages:

  • `Plain m: The body m is written as-is
  • `Base64 m: The body m needs to be BASE-64-encoded in order to create the ASCII armor
  • `OpenPGP(h,m,chksum): There is a header h, a body m which will be BASE-64-encoded, and a checksum chksum
Sourcetype armored_message_ro = [
  1. | `Plain of Netmime.mime_body_ro
  2. | `Base64 of Netmime.mime_body_ro
  3. | `OpenPGP of Netmime.mime_header_ro * Netmime.mime_body_ro * int
]

The read-only version of armored_message

Sourcetype armor_spec = (string * armor_type) list

Which types of armor to decode, and how. The strings are the identifiers in the boundaries, e.g. include "PRIVACY-ENHANCED MESSAGE" if the boundaries are "-----BEGIN PRIVACY-ENHANCED MESSAGE-----" and "-----END PRIVACY-ENHANCED MESSAGE-----". For every type you can define the armor_type.

Parses the channel, and returns all messages that are enabled in the specification.

The channel is read line-by-line.