Data.MIME.EncodedWord

encoded-words for representing non-7bit ASCII data in headers (RFC 2047 and RFC 2231).

Documentation

decodeEncodedWord :: CharsetLookup -> EncodedWord -> Text

Decode an EncodedWord. If transfer or charset decoding fails, returns the serialised encoded word.

decodeEncodedWords :: CharsetLookup -> ByteString -> Text

RFC 2047 and RFC 2231 define the encoded-words mechanism for embedding non-ASCII data in headers. This function locates encoded-words and decodes them.

λ> T.putStrLn $ decodeEncodedWords defaultCharsets "hello =?utf-8?B?5LiW55WM?=!"
hello 世界!

If parsing fails or the encoding is unrecognised the encoded-word is left unchanged in the result.

λ> T.putStrLn $ decodeEncodedWords defaultCharsets "=?utf-8?B?bogus?="
=?utf-8?B?bogus?=

λ> T.putStrLn $ decodeEncodedWords defaultCharsets "=?utf-8?X?unrecognised_encoding?="
=?utf-8?X?unrecognised_encoding?=

Language specification is supported (the datum is discarded).

λ> T.putStrLn $ decodeEncodedWords defaultCharsets "=?utf-8*es?Q?hola_mundo!?="
hola mundo!

data EncodedWord

Instances

HasTransferEncoding EncodedWord

Defined in Data.MIME.EncodedWord

Associated Types

type TransferDecoded EncodedWord

Methods

transferEncodingName :: Getter EncodedWord TransferEncodingName

transferEncodedData :: Getter EncodedWord ByteString

transferDecoded :: (AsTransferEncodingError e, Profunctor p, Contravariant f) => Optic' p f EncodedWord (Either e (TransferDecoded EncodedWord))

transferDecoded' :: (Profunctor p, Contravariant f) => Optic' p f EncodedWord (Either TransferEncodingError (TransferDecoded EncodedWord))

transferEncode :: TransferDecoded EncodedWord -> EncodedWord

type TransferDecoded EncodedWord

Defined in Data.MIME.EncodedWord

type TransferDecoded EncodedWord

encodedWord :: Parser EncodedWord

buildEncodedWord :: EncodedWord -> Builder

encodeEncodedWords :: Text -> ByteString

This function encodes necessary parts of some text

Currently turns the whole text into a single encoded word, if necessary.

chooseEncodedWordEncoding :: ByteString -> Maybe (TransferEncodingName, TransferEncoding)