131. Mail

Data for configuration of mail, input and output functions.

131.1. Summary of Module Globals

List of Global Functions

  • AutoPackages - Return required packages for auto-installation

  • CreateConfig - If MAIL_CREATE_CONFIG is not yes, the user does not want SuSEconfig to modify sendmail.cf/main.cf. So we will warn him before setting it to yes.

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

  • Fake - Make up data for screnshots

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

  • ProbePackages - Detect which packages have to be installed and return a descriptive string for a plain text pop-up.

  • Read - Read all mail settings from the SCR

  • Summary - Summary

  • Touch - A convenient shortcut for setting touched.

  • Write - Update the SCR according to mail settings

List of Global Variables

  • amavis_allowed - Is amavis available on the installation media?

  • connection_type - `permanent, `dialup or `none

  • fetchmail - List of maps: $[server:, protocol:, remote_user:, local_user:, password:, enabled:(bool), other_(server|client)_options: ]

  • fetchmail_mode - When should fetchmail run: <dl> <dt> `manual <dd> <dt> `ppp <dd> for a ppp conection, /etc/ppp/ip-{up,down}.d <dt> `network <dd> for any network connection, /etc/sysconfig/network/if-{up,down}.d </dl> #22903 Unused yet! #37139, just enable rcfetchmail.

  • from_header - Mail will appear to come from this domain. Applies also for the envelope. Does not apply for mail from root.

  • install_packages - Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

  • listen_remote - If false, port 25 will listen only for localhost

  • local_domains - Domains for locally delivered mail. (ahost.acompany.com is a domain)

  • masquerade_other_domains - If empty, from_header will be applied to mails coming from local_domains, otherwise from these domains. (Remember: mail domains)

  • masquerade_users - User specific sender masquerading. List of maps: $[comment:, user:, address:] (all are strings)

  • mta - `sendmail, `postfix or `other Initialized by ReadMta

  • outgoing_mail_server - A relay server for outgoing mail. May be enclosed in [brackets] to prevent MX lookups.

  • postfix_mda - sysconfig/postfix:POSTFIX_MDA #26052

  • protocol_choices - Fetchmail protocols, as defined in rcfile_l.l Probably not all of them are compatible with our simplified scheme but it does not hurt to include them. Must check for validity: the agent matches [[:alnum:]]+, lowercase names are valid too.

  • remove_packages - Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

  • required_packages - Required packages

  • smtp_auth - SMTP AUTH (#23000) list of maps: The ui only handles the first list item, the rest is for autoyast $[server: string, user: string, password: string(plain text)] There are other map keys that must be preserved on editing.

  • touched - Has the configuration been changed? Can be used as an argument to Popup::ReallyAbort

  • use_amavis - Use a virus scanner (AMaViS). amavisd-new (mta-independent) must be installed. It will be installed if amavis_allowed and it is not installed.

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

  • write_only - If true, don't run SuSEconfig or restart the services. Autoinstall uses this to do all in one place.

131.2. Global Functions

131.2.1. AutoPackages

Return required packages for auto-installation

Return value

  • map - of packages to be installed and to be removed

131.2.2. CreateConfig

If MAIL_CREATE_CONFIG is not yes, the user does not want SuSEconfig to modify sendmail.cf/main.cf. So we will warn him before setting it to yes.

Return value

  • boolean - Is it yes?

131.2.3. Export

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

Return value

  • map - Dumped settings (later acceptable by Import ())

131.2.4. Fake

Make up data for screnshots

Return value

  • void

131.2.5. Import

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

Function parameters

  • map Settings

Return value

  • boolean - True on success

131.2.6. ProbePackages

Detect which packages have to be installed and return a descriptive string for a plain text pop-up.

Return value

  • string - "" or "Foo will be installed.\nBar will be installed.\n"

131.2.7. Read

Read all mail settings from the SCR

Function parameters

  • block<boolean> abort

Return value

  • boolean - True on success

131.2.8. Summary

Summary

Return value

  • string - with summary of configuration

131.2.9. Touch

A convenient shortcut for setting touched.

Function parameters

  • boolean really

Return value

  • void

Example 24. 

 Mail::Touch (Mail::var != ui_var);


131.2.10. Write

Update the SCR according to mail settings

Function parameters

  • block<boolean> abort

Return value

  • boolean - True on success

131.3. Global Variables

131.3.1. amavis_allowed

Is amavis available on the installation media?

131.3.2. connection_type

`permanent, `dialup or `none

131.3.3. fetchmail

List of maps: $[server:, protocol:, remote_user:, local_user:, password:, enabled:(bool), other_(server|client)_options: ]

131.3.4. fetchmail_mode

When should fetchmail run: <dl> <dt> `manual <dd> <dt> `ppp <dd> for a ppp conection, /etc/ppp/ip-{up,down}.d <dt> `network <dd> for any network connection, /etc/sysconfig/network/if-{up,down}.d </dl> #22903 Unused yet! #37139, just enable rcfetchmail.

131.3.5. from_header

Mail will appear to come from this domain. Applies also for the envelope. Does not apply for mail from root.

131.3.6. install_packages

Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

131.3.7. listen_remote

If false, port 25 will listen only for localhost

131.3.8. local_domains

Domains for locally delivered mail. (ahost.acompany.com is a domain)

131.3.9. masquerade_other_domains

If empty, from_header will be applied to mails coming from local_domains, otherwise from these domains. (Remember: mail domains)

131.3.10. masquerade_users

User specific sender masquerading. List of maps: $[comment:, user:, address:] (all are strings)

131.3.11. mta

`sendmail, `postfix or `other Initialized by ReadMta

131.3.12. outgoing_mail_server

A relay server for outgoing mail. May be enclosed in [brackets] to prevent MX lookups.

131.3.13. postfix_mda

sysconfig/postfix:POSTFIX_MDA #26052

131.3.14. protocol_choices

Fetchmail protocols, as defined in rcfile_l.l Probably not all of them are compatible with our simplified scheme but it does not hurt to include them. Must check for validity: the agent matches [[:alnum:]]+, lowercase names are valid too.

131.3.15. remove_packages

Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

131.3.16. required_packages

Required packages

131.3.17. smtp_auth

SMTP AUTH (#23000) list of maps: The ui only handles the first list item, the rest is for autoyast $[server: string, user: string, password: string(plain text)] There are other map keys that must be preserved on editing.

131.3.18. touched

Has the configuration been changed? Can be used as an argument to Popup::ReallyAbort

131.3.19. use_amavis

Use a virus scanner (AMaViS). amavisd-new (mta-independent) must be installed. It will be installed if amavis_allowed and it is not installed.

131.3.20. virtual_users

Domain-specific aliases. List of maps: $[comment:, alias:, destinations:] (all are strings)

131.3.21. write_only

If true, don't run SuSEconfig or restart the services. Autoinstall uses this to do all in one place.

131.4. Module Requirements

131.4.1. Module Imports

  • MailAliases
  • MailTable
  • Mode
  • Package
  • PackageSystem
  • Progress
  • Report
  • Service
  • SuSEFirewall
  • Summary

131.4.2. Module Includes