YaST2 Developers Documentation: Configuration of mail-server

Configuration of mail-server

modules/MailServer.ycp
MailServer settings, input and output functions
  • Peter Varkoly

This module has an unstable interface.

Representation of the configuration of mail-server. Input and output routines.

Imports

  • Label
  • Ldap
  • NetworkInterfaces
  • Package
  • Popup
  • Progress
  • Report
  • Service
  • Summary
  • Users
  • YaPI::MailServer

Global Variables

Global Functions

Local Functions

global Modified () -> boolean

Prototypes

global modified -> boolean

Data was modified?

global proposal_valid -> boolean

global write_only -> boolean

Write only, used during autoinstallation. Don't run services, it's all done at one place.

Info:

Abort function return boolean return true if abort

global Abort () -> boolean

Abort function

Return value:
blah blah lahjk
global setup -> boolean

True if the modul was started with the option 'setup'.

global CertExist -> boolean

True if there is server certificate.

global GlobalSettings -> map<string,any>

Map of the mail server global settings.

global MailTransports -> map<string,any>

Map of the mail transport settings.

global MailPrevention -> map<string,any>

Map of the mail server prevention settings.

global MailRelaying -> map<string,any>

Map of the mail server relaying settings.

global MailLocalDelivery -> map<string,any>

Map of the mail server local delivery settings.

global FetchingMail -> map<string,any>

Map of the mail server fetching mail jobs.

global MailLocalDomains -> map<string,any>

Map of the mail server local domains.

global Modified () -> boolean

Data was modified?

Return value:
true if modified
global LDAPDefaults -> map<string,any>

Map of the mail server local domains.

global PPPCards -> list<string>

List of the PPP devices

global AdminPassword -> string

Some additional parameter needed for the configuration.

global ModulesTreeContent -> list<list>

List of the Configuration Modules

local Installed (string package) -> boolean

Is a package installed?

Parameters:
package package name, without version or .rpm suffix
Return value:
true/false
global CheckPackages () -> boolean

Check if all needed packages are installed

Return value:
true on success
global Read () -> boolean

Read all mail-server settings

Return value:
true on success
global Write () -> boolean

Write all mail-server settings

Return value:
true on success
global Import (map settings) -> boolean

Get all mail-server settings from the first parameter (For use by autoinstallation.)

Parameters:
settings The YCP structure to be imported.
Return value:
True on success
global Export () -> map

Dump the mail-server settings to a single map (For use by autoinstallation.)

Return value:
Dumped settings (later acceptable by Import ())
global Summary () -> list

Create a textual summary and a list of unconfigured cards

Return value:
summary of the current configuration
global Overview () -> list

Create an overview table with all configured cards

Return value:
table items
global AutoPackages () -> map

Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

Return value:
with 2 lists.