Skip to content

kumo.encode.charset_decode

kumo.encode.charset_decode(CHARSET, BINARY_INPUT)
Since: Dev Builds Only

The functionality described in this section requires a dev build of KumoMTA. You can obtain a dev build by following the instructions in the Installation section.

Given an the input string BINARY_INPUT, which is likely a binary string, attempt to decode the string from the named CHARSET, which must be one of the charsets supported by the converter (the most common latin, japanese, chinese, korean and cyrillic code pages are supported), into UTF-8.

Any error attempt to decode the string will cause a lua error to propagate.

The return value, on successful decoding, will be a representation of BINARY_INPUT encoded as UTF-8.