YaST2 Developers Documentation: Configuration of mail

Configuration of mail

include/mail/ui.ycp
User interface functions.
  • Martin Vidner

This module has an unstable interface.

All user interface functions.

Imports

  • CWMFirewallInterfaces
  • Hostname
  • Label
  • Mail
  • MailAliases
  • Mode
  • Package
  • Popup
  • Progress
  • Sequencer
  • Wizard

Includes

  • mail/helps.ycp
  • mail/wj.ycp

Local Variables

Local Functions

local ReadDialog () -> symbol

Read settings dialog

Return value:
`abort or `next
local ConfirmDialog () -> symbol

Confirmation dialog before saving and installing needed packages

Return value:
`back or `next
local WriteDialog () -> symbol

Write settings dialog

Return value:
`abort or `next
local MtaSelectionDialog () -> symbol

MTA selection dialog (only for autoinstallation, otherwise probed in Mail::Read)

Return value:
`abort or `next
local preselect_connection_type -> symbol

A command line argument can override what is read from SCR. Used when starting mail from lan/modem.

local ConnectionTypeDialog () -> symbol

D1

Return value:
`back, `abort, `next or `none
local OutgoingDialog () -> symbol

D2

Return value:
`back, `abort, `next or `outgoing_details
local IncomingDialog () -> symbol

D2

Return value:
`back, `abort, `next or `outgoing_details
local check_username (string username) -> boolean

(taken from y2c_users ui.ycp)

Parameters:
username a string
Return value:
Whether a string contains only valid user name characters
local valid_username () -> string

(taken from y2c_users ui.ycp)

Return value:
Describe a valid username
local check_mail_address (string address) -> boolean

See RFC 2822, 3.4 But for now, no-spaces@valid_domainname

Parameters:
address an address to check
Return value:
valid?
local MasqueradeUserPopup (map defaultv, list<map> existing) -> map

D2.1.1 Used for adding and editing a user masquerading entry.

Parameters:
defaultv $["user": "address":] or just $[]
existing current masqueading list
Return value:
$["comment": "", "user": "address":] or $[] on cancel
local OutgoingDetailsDialog () -> symbol

D2.1

Return value:
`back, `abort or `next
local OutgoingAuthOptions () -> symbol

D2.2 Outgoing server authentification

Return value:
`back, `abort or `next
local FetchmailPopup (map defaultv, list<map> existing) -> map

D3.1

Parameters:
defaultv $[server:, protocol:, remote_user:, local_user:, password:, ...]
existing unused
Return value:
edited data (with no other fields) or $[] on cancel
local DownloadingDialog () -> symbol

D3

Return value:
`back, `abort or `next
local AliasPopup (map defaultv, list<map> existing) -> map

D1.1.1, 1.2.1 Used for adding and editing an alias/virtual domain entry.

Parameters:
defaultv $["alias": "destinations": ?comment] or just $[]
existing current entry list
Return value:
$["comment": ""?, "alias": "destinations":] or $[] on cancel
local AliasesDialog () -> symbol

D1.1

Return value:
`back, `abort or `next
local VirtualDialog () -> symbol

D1.2

Return value:
`back, `abort or `next
local JustNext () -> symbol

A Wizard Sequencer helper

Return value:
`next
local MailSequence () -> symbol

Whole configuration of mail

Return value:
`back, `abort or `next
local MailAutoSequence () -> symbol

Whole configuration of mail but without reading and writing. MTA is selected first. For use with autoinstallation.

Return value:
`back, `abort or `next