univention.mail package

Submodules

univention.mail.dovecot module

class univention.mail.dovecot.DovecotListener(listener: str, name: str)

Bases: object

log_p(msg: str) → None

log_e(msg: str) → None

new_email_account(email: str) → None

delete_email_account(dn: str, email: str) → None

read_from_ext_proc_as_root(cmd: Sequence[str], regexp: str | None = None, stdin: str | None = None, stdout: Any = -1, stderr: Any = None, stdin_input: Any = None) → str

Wrapper around Popen(), runs external command as root and return its output, optionally the first hit of a regexp. May raise an exception.

Parameters:

• cmd – list: with executable path as first item

• regexp – string: regexp for re.findall()

Returns:

string

move_user_home(newMailPrimaryAddress: str, oldMailPrimaryAddress: str, force_rename: bool = False) → None

move_mail_home(old_path: str, new_path: str, email: str, force_rename: bool = False) → None

get_maillocation() → str

upload_activate_sieve_script(email: str, file: str) → None

get_user_home(username: str) → str

get_masteruser_credentials() → tuple[str, str]

get_dovecot_user() → tuple[str, str]

mkdir_p(dir: str) → None

classmethod chown_r(path: str, uid: int, gid: int) → None

Recursively set owner and group on a file/directory and its subdirectories.

Parameters:

• path (str) – file/directory (and its subdirectories) to change ownership on

• uid (int) – UID to set

• gid (int) – GID to set

Returns:

None

univention.mail.dovecot_shared_folder module

class univention.mail.dovecot_shared_folder.DovecotFolderAclEntry(folder_name: str, identifier: str, acl: str)

Bases: object

classmethod from_str(line: str) → Self

class univention.mail.dovecot_shared_folder.DovecotGlobalAclFile(listener: Any)

Bases: object

dovemail_gid = 102

add_acls(acl_list: list[DovecotFolderAclEntry]) → None

remove_acls(folder_name: str) → None

class univention.mail.dovecot_shared_folder.DovecotSharedFolderListener(*args, **kwargs)

Bases: DovecotListener

add_shared_folder(new: dict[str, list[bytes]]) → None

del_shared_folder(old: dict[str, list[bytes]]) → None

mod_shared_folder(old: dict[str, list[bytes]], new: dict[str, list[bytes]]) → None

get_public_location(ns: str) → str

create_public_folder(folder_name: str) → str

read_from_ext_proc_as_root(cmd, regexp=None, stdin=None, stdout=-1, stderr=None, stdin_input=None)

Wrapper around Popen(), runs external command as root and return its output, optionally the first hit of a regexp. May raise an exception.

Parameters:

• cmd – list: with executable path as first item

• regexp – string: regexp for re.findall()

Returns:

string

doveadm_set_mailbox_acls(mailbox: str, acls: list[str]) → None

imap_set_mailbox_acls(mb_owner: str, mailbox: str, acls: list[str]) → None

update_public_mailbox_configuration(delete_only: str | None = None) → None

Cache public folders and their quota into a UCRV.

Parameters:

delete_only – if True removes only entry ‘delete_only’, else recreates from scratch.

Returns:

None

unsubscribe_from_mailbox(users: list[str], mailbox: str) → None

get_udm_infos(udm_module: Any, udm_filter: str) → list[Any]

add_global_acls(new: dict[str, list[bytes]]) → None

remove_global_acls(old: dict[str, list[bytes]]) → None