119. MailAliases

Data for configuration of mail aliases, input and output functions.

119.1. Summary of Module Globals

List of Global Functions

  • FilterRootAlias - Separates aliases into aliases, root_alias and root_alias_comment

  • GetRootAlias - For use by the Users package. Does not rely on the internal state, first calls the agent.

  • MergeRootAlias -

  • ReadAliases - Read the aliases table (and separate the root alias)

  • SetRootAlias - For use by the Users package. Does not use the internal state, just calls the agent. SuSEconfig or newaliases is NOT called! (TODO: what if it is called while the main module is running?) Errors are reported via Report::Error.

  • WriteAliases - Part of Write.

List of Global Variables

  • aliases - List of maps: $[comment:, alias:, destinations:] (all are strings) Except root.

  • root_alias - Separated/joined with aliases by read/write/set/export

119.2. Global Functions

119.2.1. FilterRootAlias

Separates aliases into aliases, root_alias and root_alias_comment

Return value

  • void

119.2.2. GetRootAlias

For use by the Users package. Does not rely on the internal state, first calls the agent.

Return value

  • string - eg. "joe, \\root", "" if not defined

119.2.3. MergeRootAlias

Function parameters

  • list<map> aliases

Return value

  • list<map> - prepend root alias data to aliases, if set

119.2.4. ReadAliases

Read the aliases table (and separate the root alias)

Return value

  • boolean - success?

119.2.5. SetRootAlias

For use by the Users package. Does not use the internal state, just calls the agent. SuSEconfig or newaliases is NOT called! (TODO: what if it is called while the main module is running?) Errors are reported via Report::Error.

Function parameters

  • string destinations

Return value

  • boolean - true on success

119.2.6. WriteAliases

Part of Write.

Return value

  • boolean - success

119.3. Global Variables

119.3.1. aliases

List of maps: $[comment:, alias:, destinations:] (all are strings) Except root.

119.3.2. root_alias

Separated/joined with aliases by read/write/set/export

119.4. Module Requirements

119.4.1. Module Imports

  • MailTable

119.4.2. Module Includes