Plugin API

Handy functions in the fuglu.shared module

fuglu.shared.actioncode_to_string(actioncode)

Return the human readable string for this code

fuglu.shared.apply_template(templatecontent, suspect, values=None, valuesfunction=None)

Replace templatecontent variables as defined in https://fumail.gitlab.io/fuglu/plugins-index.html#template-variables with actual values from suspect the calling function can pass additional values by passing a values dict

if valuesfunction is not none, it is called with the final dict with all built-in and passed values and allows further modifications, like SQL escaping etc

fuglu.shared.default_template_values(suspect, values=None)

Return a dict with default template variables applicable for this suspect if values is not none, fill the values dict instead of returning a new one

fuglu.shared.string_to_actioncode(actionstring, config=None)

return the code for this action

The Suspect class

class fuglu.shared.Suspect(from_address: str, recipients: Union[str, List[str]], tempfile: Optional[str], inbuffer: Optional[bytes] = None, smtp_options: Optional[Set] = None, **kwargs)

The suspect represents the message to be scanned. Each scannerplugin will be presented with a suspect and may modify the tags or even the message content itself.

add_header(key, value, immediate=False)

adds a header to the message. by default, headers will added when re-injecting the message back to postfix if you set immediate=True the message source will be replaced immediately. Only set this to true if a header must be visible to later plugins (eg. for spamassassin rules), otherwise, leave as False which is faster.

added_headers

To keep track of already added headers (not in self.addheaders)

check_id(id=None)

verify id is a valid fuglu id (a string of 32 hex characters)

client_info_from_rcvd(ignoreregex=None, skip=0, skiponerror=False, ignorelineregex=None, skipsamedomain=False)

returns information about the client that submitted this message. (helo,ip,reversedns)

This information is extracted from the message Received: headers and therefore probably not 100% reliable all information is returned as-is, this means for example, that non-fcrdns client will show ‘unknown’ as reverse dns value.

if ignoreregex is not None, all results which match this regex in either helo,ip or reversedns will be ignored if ignorelineregex is not None, all results which match this regex will be ignored if skipsamedomain is True, ignore received lines where from & by domain is in same domain

By default, this method starts searching at the top Received Header. Set a higher skip value to start searching further down.

both these arguments can be used to filter received headers from local systems in order to get the information from a boundary MTA

returns None if the client info can not be found or if all applicable values are filtered by skip/ignoreregex

clientinfo

Attachment manager

debug(message)

Add a line to the debug log if debugging is enabled for this message

static decode_msg_header(header, decode_errors='replace')

Decode message header from email.message into unicode string

Args:

header (str, email.header.Header): the header to decode decode_errors (str): error handling as in standard bytes.decode -> strict, ignore, replace

Returns:

str

static generate_id()

returns a unique id (a string of 32 hex characters)

get_client_info(config=None)

returns information about the client that submitted this message. (helo,ip,reversedns)

In before-queue mode this info is extracted using the XFORWARD SMTP protocol extension.

In after-queue mode this information is extracted from the message Received: headers and therefore probably not 100% reliable all information is returned as-is, this means for example, that non-fcrdns client will show ‘unknown’ as reverse dns value.

if no config object is passed, the first parseable Received header is used. otherwise, the config is used to determine the correct boundary MTA (trustedhostsregex / boundarydistance)

get_headers()

Returns the message headers as string

Returns:

(unicode str) unicode for Py2, str for Py3

get_message_rep()

returns the python email api representation of this suspect

get_original_source(maxbytes=None)

returns the original, unmodified message source

get_sa_temp_headers(plugin='SAPlugin')

returns temporary pseude headers as a bytes string. :param plugin: name of destination plugin. defaults to SAPlugin :return: bytes: temp headers

get_source(maxbytes=None)

returns the current message source, possibly changed by plugins

get_tag(key, defaultvalue=None)

returns the tag value. if the tag is not found, return defaultvalue instead (None if no defaultvalue passed)

static getlist_space_comma_separated(inputstring)

Create list from string, splitting at ‘,’ space

is_blocked()

Returns True if ANY plugin tagged this suspect as blocked content

is_blocklisted()

Returns True if ANY plugin tagged this suspect as ‘not welcome by recipient’

is_ham()

Returns True if message is neither considered to be spam, virus, blocked or blocklisted

is_highspam()

Returns True if ANY of the spam engines tagged this suspect as high spam

is_modified()

returns true if the message source has been modified

is_spam()

Returns True if ANY of the spam engines tagged this suspect as spam

is_virus()

Returns True if ANY of the antivirus engines tagged this suspect as infected

is_welcomelisted()

Returns True if ANY plugin tagged this suspect as ‘welcome by recipient’

modified_headers

To keep track of modified headers

parse_from_type_header(header='From', validate_mail=True, recombine=True)

Args:

header (str): name of header to extract, defaults to From validate_mail (bool): base checks for valid mail recombine (bool): recombine displaypart with mailaddress

Returns:

[(displayname,email), … ]

• displayname (str) : display name

• email (str) : email address

static prepend_header_to_source(key, value, source)

Prepend a header to the message

Args:

key (str): the header key value (str): the header value source (bytes): the message source

Returns:

bytes: the new message buffer

set_header(key, value)

Replace existing header or create a new one

Args:

key (string): header key value (string): header value

set_message_rep(msgrep, att_mgr_reset=True)

replace the message content. this must be a standard python email representation Warning: setting the source via python email representation seems to break dkim signatures!

The attachment manager is build based on the python mail representation. If no message attachments or content is modified there is no need to recreate the attachment manager.

Args:

msgrep (email): standard python email representation att_mgr_reset (bool): Reset the attachment manager

set_source(source, encoding='utf-8', att_mgr_reset=True)

Store message source. This might be modified by plugins later on…

Args:

source (bytes,str,unicode): new message source

Keyword Args:

encoding (str): encoding, default is utf-8 att_mgr_reset (bool): Reset the attachment manager

set_tag(key, value)

Set a new tag

source

holds the message source if set directly

source_stripped_attachments(content=None, maxsize=None, with_mime_headers=False)

strip all attachments from multipart mails except for plaintext and html text parts. if message is still too long, truncate.

Args:

content (string,bytes): message source maxsize (integer): maximum message size accepted with_mime_headers (boolean): add mime headers from attachments

Returns:

bytes: stripped and truncated message content

property to_address

Returns the first recipient address

property to_domain

Returns the local part of the first recipient

property to_localpart

Returns the local part of the first recipient

update_subject(subject_cb, **cb_params)

update/alter the message subject :param subject_cb: callback function that alters the subject. must accept a string and return a string :param cb_params: additional parameters to be passed to subject_cb :return: True if subject was altered, False otherwise

write_sa_temp_header(header, value, plugin='SAPlugin')

Write a temporary pseudo header. This is used by e.g. SAPlugin to pass extra information to external services :param header: pseudo header name :param value: pseudo header value :param plugin: name of destination plugin. defaults to SAPlugin :return: None

The SuspectFilter class

class fuglu.shared.SuspectFilter(*args, **kwargs)

Allows filtering Suspect based on header/tag/body regexes

get_args(suspect, extended=False)

returns all args of matched regexes in a list if extended=True: returns a list of tuples with all available information: (fieldname, matchedvalue, arg, regex)

get_decoded_textparts(suspect, attachment=None, inline=None)

Get all text parts of suspect as a list. Text parts can be limited by the attachment, inline keywords which checks the Content-Disposition header:

attachment: True/False/None

None: Ignore True: attachment or header not present False: no attachment

inline: True/False/None

None: Ignore True: inline attachment False: no inline attachment or header present, so attached textparts are included

Args:

suspect (Suspect, PatchedMessage): Suspect object attachment (bool, NoneType): filter for attachments inline (bool, NoneType): filter for inline attachments

The input should be a Suspect. Due to backward compatibility email.message.Message is still supported and passed to the deprecated routine which will however NOT handle the additional keyword parameters for filtering attachments and inline attachments.

Returns:

list: List containing decoded text parts

get_decoded_textparts_deprecated(messagerep)

Returns a list of all text contents

get_field(suspect, headername)

return a list of mail header values or special values. If the value can not be found, an empty list is returned.

headers:

just the headername or header:<headername> for standard message headers mime:headername for attached mime part headers

envelope data:

envelope_from (or from_address) envelope_to (or to_address) from_domain to_domain clientip clienthostname (fcrdns or ‘unknown’) clienthelo

tags

@tagname

body source:

body:full -> (full source, encoded) body:stripped (or just ‘body’) : -> returns text/* bodyparts with tags and newlines stripped body:raw -> decoded raw message body parts

lint()

check file and print warnings to console. returns True if everything is ok, False otherwise

matches(suspect, extended=False)

returns (True,arg) if any regex matches, (False,None) otherwise

if extended=True, returns all available info about the match in a tuple: True, (fieldname, matchedvalue, arg, regex)

strip_text(content, remove_tags=None, replace_nbsp=True, use_bfs=True)

Strip HTML Tags from content, replace newline with space (like Spamassassin)

Returns:

(unicode/str) Unicode string (Py3 ‘str’ is unicode string)