Module lua_mime

This module contains helper functions to modify mime parts

Brief content:

Functions:

Function	Description
lua_mime.add_text_footer(task, html_footer, text_footer)	Adds a footer to all text parts in a message.
lua_mime.multipattern_text_replace(task, mp, replacements)	Replaces text according to multipattern matches.
lua_mime.modify_headers(task, {add = {hname = {value = 'value', order = 1}}, remove = {hname = {1,2}}})	Adds/removes headers both internal and in the milter reply.
lua_mime.message_to_ucl(task, [stringify_content])	Exports a message to an ucl object.
lua_mime.message_to_ucl_schema()	Returns schema for a message to verify result/document fields.

Functions

The module lua_mime defines the following functions.

Function lua_mime.add_text_footer(task, html_footer, text_footer)

Adds a footer to all text parts in a message. It returns a table with the following fields:

• out: new content (body only)
• need_rewrite_ct: boolean field that means if we must rewrite content type
• new_ct: new content type (type => string, subtype => string)
• new_cte: new content-transfer encoding (string)

Parameters:

No parameters

Returns:

No return

Back to module description.

Function lua_mime.multipattern_text_replace(task, mp, replacements)

Replaces text according to multipattern matches. It returns a table with the following fields:

• out: new content (body only)
• need_rewrite_ct: boolean field that means if we must rewrite content type
• new_ct: new content type (type => string, subtype => string)
• new_cte: new content-transfer encoding (string)

Parameters:

No parameters

Returns:

No return

Back to module description.

Function lua_mime.modify_headers(task, {add = {hname = {value = 'value', order = 1}}, remove = {hname = {1,2}}})

Adds/removes headers both internal and in the milter reply Mode defines to be compatible with Rspamd <=3.2 and is the default (equal to ‘compat’)

Parameters:

No parameters

Returns:

No return

Back to module description.

Function lua_mime.message_to_ucl(task, [stringify_content])

Exports a message to an ucl object

Parameters:

No parameters

Returns:

No return

Back to module description.

Function lua_mime.message_to_ucl_schema()

Returns schema for a message to verify result/document fields

Parameters:

No parameters

Returns:

No return

Back to module description.

Back to top.