foliolib.folio.config.Config

class foliolib.folio.config.Config(tenant: str)

Bases: foliolib.folio.FolioService

Parameters

tenant (str) – Tenant id

Methods

delete_email()

delete_entries(module)

delete_entry(module, configName, code)

delete_folio_host()

get_entries([module])

get_entry(module, configName, code)

get_folio_host()

set_email(host, port, email_from, username, ...)

Set email configuration for a tenant.

set_entry(entry)

set_folio_host(folio_host)

delete_email()
delete_entries(module)
delete_entry(module, configName, code)
delete_folio_host()
get_entries(module=None)
get_entry(module, configName, code)
get_folio_host()
set_email(host: str, port: str, email_from: str, username: str, password: str, ssl: bool = False, loginoption: Optional[str] = None, starttls: Optional[str] = None, trustall: bool = False, authmethods: Optional[str] = None)

Set email configuration for a tenant. AUTH_METHODS authentication methods ‘CRAM-MD5 LOGIN PLAIN’

Parameters

  • host (str) – The host of the smtp server.

  • port (str) – The port of the smtp server.

  • email_from (str) – The ‘from’ property of the email.

  • username (str) – The username for the login.

  • password (str) – The password for the login.

  • ssl (bool, optional) – sslOnConnect mode for the connection. Defaults to False.

  • loginoption (str, optional) – The login mode for the connection. Examples are DISABLED, OPTIONAL or REQUIRED Defaults to DISABLED.

  • starttls (str, optional) – TLS security mode for the connection. Examples are NONE, OPTIONAL or REQUIRED Defaults to NONE.

  • trustall (bool, optional) – trust all certificates on ssl connect.

  • authmethods (str, optional) – Authentication methods. Example is ‘CRAM-MD5 LOGIN PLAIN’.

set_entry(entry: foliolib.folio.config.ConfigEntry)
set_folio_host(folio_host)