ACC SHELL

Path : /usr/share/doc/packages/yast2-mail/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-mail/autodocs/Mail.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html>
 <head>
  <title>

   Configuration of mail
</title>
  <style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
 </head>
 <body>
  <div class="header">
   <i>YaST2 Developers Documentation:</i>
   <a href="index.html">
    <b>

   Configuration of mail
</b>
   </a>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
   <hr />
  </div>
  <div class="menu">
   <img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
   <br />
   <br />
   <a href="index.html">functions</a>
   <br />
   <a href="files.html">files</a>
   <br />
   <a href="intro.html">intro</a>
  </div>
  <div class="main">
   <div class="sigbox">
    <table class="padtbl">
     <tr>
      <td>
       <h1>

   Configuration of mail
</h1>
      </td>
      <td class="filecell">
   modules/Mail.ycp
</td>
     </tr>
     <tr>
      <td>
   Data for configuration of mail, input and output functions.
</td>
     </tr>
     <tr>
      <td>
       <ul>
        <li>   Martin Vidner <mvidner@suse.cz></li>
       </ul>
      </td>
     </tr>
     <tr>
      <td>
       <p>This module has an unstable interface.</p>
      </td>
     </tr>
    </table>
    <table class="padtbl">
     <tr>
      <td>

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


       <h1>Imports</h1>
       <ul>
        <li>MailAliases</li>
        <li>MailTable</li>
        <li>Mode</li>
        <li>Package</li>
        <li>PackageSystem</li>
        <li>Progress</li>
        <li>Report</li>
        <li>Service</li>
        <li>SuSEFirewall</li>
        <li>Summary</li>
       </ul>
       <h1>Global Variables</h1>
       <ul>
        <li>
         <a href="#amavis_allowed">amavis_allowed</a>
        </li>
        <li>
         <a href="#check_interval">check_interval</a>
        </li>
        <li>
         <a href="#connection_type">connection_type</a>
        </li>
        <li>
         <a href="#cron_file">cron_file</a>
        </li>
        <li>
         <a href="#fetchmail">fetchmail</a>
        </li>
        <li>
         <a href="#fetchmail_mode">fetchmail_mode</a>
        </li>
        <li>
         <a href="#from_header">from_header</a>
        </li>
        <li>
         <a href="#install_packages">install_packages</a>
        </li>
        <li>
         <a href="#listen_remote">listen_remote</a>
        </li>
        <li>
         <a href="#local_domains">local_domains</a>
        </li>
        <li>
         <a href="#masquerade_other_domains">masquerade_other_domains</a>
        </li>
        <li>
         <a href="#masquerade_users">masquerade_users</a>
        </li>
        <li>
         <a href="#mta">mta</a>
        </li>
        <li>
         <a href="#outgoing_mail_server">outgoing_mail_server</a>
        </li>
        <li>
         <a href="#postfix_mda">postfix_mda</a>
        </li>
        <li>
         <a href="#protocol_choices">protocol_choices</a>
        </li>
        <li>
         <a href="#remove_packages">remove_packages</a>
        </li>
        <li>
         <a href="#required_packages">required_packages</a>
        </li>
        <li>
         <a href="#smtp_auth">smtp_auth</a>
        </li>
        <li>
         <a href="#smtp_use_TLS">smtp_use_TLS</a>
        </li>
        <li>
         <a href="#touched">touched</a>
        </li>
        <li>
         <a href="#use_amavis">use_amavis</a>
        </li>
        <li>
         <a href="#virtual_users">virtual_users</a>
        </li>
        <li>
         <a href="#write_only">write_only</a>
        </li>
       </ul>
       <h1>Global Functions</h1>
       <ul>
        <li>
         <a href="#AutoPackages">AutoPackages ()</a>
        </li>
        <li>
         <a href="#CreateConfig">CreateConfig ()</a>
        </li>
        <li>
         <a href="#Export">Export ()</a>
        </li>
        <li>
         <a href="#Fake">Fake ()</a>
        </li>
        <li>
         <a href="#Import">Import (map Settings)</a>
        </li>
        <li>
         <a href="#ProbePackages">ProbePackages ()</a>
        </li>
        <li>
         <a href="#Read">Read (block&lt;boolean&gt; abort)</a>
        </li>
        <li>
         <a href="#ReadWithoutCallback">ReadWithoutCallback ()</a>
        </li>
        <li>
         <a href="#Summary">Summary ()</a>
        </li>
        <li>
         <a href="#Touch">Touch (boolean really)</a>
        </li>
        <li>
         <a href="#Write">Write (block&lt;boolean&gt; abort)</a>
        </li>
        <li>
         <a href="#WriteAliasesAndVirtual">WriteAliasesAndVirtual ()</a>
        </li>
        <li>
         <a href="#WriteDownloading">WriteDownloading ()</a>
        </li>
        <li>
         <a href="#WriteFlush">WriteFlush ()</a>
        </li>
        <li>
         <a href="#WriteGeneral">WriteGeneral ()</a>
        </li>
        <li>
         <a href="#WriteMasquerading">WriteMasquerading ()</a>
        </li>
        <li>
         <a href="#WriteServices">WriteServices ()</a>
        </li>
        <li>
         <a href="#WriteSmtpAuth">WriteSmtpAuth ()</a>
        </li>
        <li>
         <a href="#WriteSuSEconfig">WriteSuSEconfig ()</a>
        </li>
        <li>
         <a href="#WriteWithoutCallback">WriteWithoutCallback ()</a>
        </li>
       </ul>
       <h1>Local Variables</h1>
       <ul>
        <li>
         <a href="#amavis_service">amavis_service</a>
        </li>
        <li>
         <a href="#enable_smtp_auth">enable_smtp_auth</a>
        </li>
        <li>
         <a href="#sendmail_all_mechanisms">sendmail_all_mechanisms</a>
        </li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#ListItem">ListItem (string title, any value, any index)</a>
        </li>
        <li>
         <a href="#ReadMta">ReadMta ()</a>
        </li>
        <li>
         <a href="#RunFetchmailGlobally">RunFetchmailGlobally ()</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="required_packages">global
     <b>required_packages
      <span class="a"> -&gt; </span>
      <span class="t">list</span>
     </b>
    </span>
   </div>
   <p>
 Required packages</p>
   <div class="sigbox">
    <span class="sig" id="mta">global
     <b>mta
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 `sendmail, `postfix or `other
 Initialized by ReadMta</p>
   <div class="sigbox">
    <span class="sig" id="write_only">global
     <b>write_only
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
	If true, don't run SuSEconfig or restart the services.
  Autoinstall uses this to do  all in one place.</p>
   <div class="sigbox">
    <span class="sig" id="CreateConfig">global
     <b>CreateConfig ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 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.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Is it yes?</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="connection_type">global
     <b>connection_type
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 `permanent, `dialup or `none</p>
   <div class="sigbox">
    <span class="sig" id="listen_remote">global
     <b>listen_remote
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 If false, port 25 will listen only for localhost</p>
   <div class="sigbox">
    <span class="sig" id="use_amavis">global
     <b>use_amavis
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Use a virus scanner (AMaViS).
 amavisd-new (mta-independent) must be installed.
 It will be installed if amavis_allowed and it is not installed.</p>
   <div class="sigbox">
    <span class="sig" id="amavis_allowed">global
     <b>amavis_allowed
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Is amavis available on the installation media?</p>
   <div class="sigbox">
    <span class="sig" id="local_domains">global
     <b>local_domains
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Domains for locally delivered mail.
 (ahost.acompany.com is a domain)</p>
   <div class="sigbox">
    <span class="sig" id="outgoing_mail_server">global
     <b>outgoing_mail_server
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 A relay server for outgoing mail.
 May be enclosed in [brackets] to prevent MX lookups.</p>
   <div class="sigbox">
    <span class="sig" id="smtp_use_TLS">global
     <b>smtp_use_TLS
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Do the MTA use TLS for sending the email.</p>
   <div class="sigbox">
    <span class="sig" id="from_header">global
     <b>from_header
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Mail will appear to come from this domain. Applies also for the
 envelope. Does not apply for mail from root.</p>
   <div class="sigbox">
    <span class="sig" id="masquerade_other_domains">global
     <b>masquerade_other_domains
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 If empty, from_header will be applied to mails coming from
 local_domains, otherwise from these domains. (Remember: mail
 domains)</p>
   <div class="sigbox">
    <span class="sig" id="masquerade_users">global
     <b>masquerade_users
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;map&gt;</span>
     </b>
    </span>
   </div>
   <p>
 User specific sender masquerading.
 List of maps: $[comment:, user:, address:] (all are strings)</p>
   <div class="sigbox">
    <span class="sig" id="postfix_mda">global
     <b>postfix_mda
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 sysconfig/postfix:POSTFIX_MDA
 #26052</p>
   <div class="sigbox">
    <span class="sig" id="fetchmail_mode">global
     <b>fetchmail_mode
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 When should fetchmail run:
 <dl>
 <dt> "manual"  <dd>
 <dt> "daemon"  <dd></p>
   <div class="sigbox">
    <span class="sig" id="fetchmail">global
     <b>fetchmail
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;map&gt;</span>
     </b>
    </span>
   </div>
   <p>
List of maps:
 $[server:, protocol:, remote_user:, local_user:, password:,
 enabled:(bool), other_(server|client)_options: ]</p>
   <div class="sigbox">
    <span class="sig" id="virtual_users">global
     <b>virtual_users
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;map&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Domain-specific aliases.
 List of maps: $[comment:, alias:, destinations:] (all are strings)</p>
   <div class="sigbox">
    <span class="sig" id="smtp_auth">global
     <b>smtp_auth
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;map&gt;</span>
     </b>
    </span>
   </div>
   <p>
 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.</p>
   <div class="sigbox">
    <span class="sig" id="enable_smtp_auth">local
     <b>enable_smtp_auth
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Sysconfig setting that enables the feature.
 For postfix, it is a simple yes/no which we set to (size(smtp_auth)>0)
 For sendmail, it is a list of methods which we set to empty or all
 but we don't touch it if it was something in between, marked as nil.
 Must default to non-nil.</p>
   <div class="sigbox">
    <span class="sig" id="sendmail_all_mechanisms">local
     <b>sendmail_all_mechanisms
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 The full set of authentication mechanisms for sendmail</p>
   <div class="sigbox">
    <span class="sig" id="protocol_choices">global
     <b>protocol_choices
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 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.</p>
   <div class="sigbox">
    <span class="sig" id="touched">global
     <b>touched
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Has the configuration been changed?
 Can be used as an argument to Popup::ReallyAbort</p>
   <div class="sigbox">
    <span class="sig" id="Touch">global
     <b>Touch (boolean really)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 A convenient shortcut for setting touched.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">really</span>
       </td>
       <td class="descbox">if true, set Mail::touched</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Example</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td align="left" valign="top"><pre>
 Mail::Touch (Mail::var != ui_var);</pre></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="install_packages">global
     <b>install_packages
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Read only, set by ProbePackages.
 Use as an argument to Package::DoInstallAndRemove</p>
   <div class="sigbox">
    <span class="sig" id="remove_packages">global
     <b>remove_packages
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Read only, set by ProbePackages.
 Use as an argument to Package::DoInstallAndRemove</p>
   <div class="sigbox">
    <span class="sig" id="amavis_service">local
     <b>amavis_service
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Of the four available amavis packages, amavis-postfix does not need
 a service running, others do.
 Update: only one package, amavisd-new, but let's keep the variable,
 just in case.
 We query rpm in WriteGeneral (so that it works for autoinst too).
 This is only used if use_amavis is on, of course.</p>
   <div class="sigbox">
    <span class="sig" id="cron_file">global
     <b>cron_file
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 The cron file name for the queue checking.</p>
   <div class="sigbox">
    <span class="sig" id="check_interval">global
     <b>check_interval
      <span class="a"> -&gt; </span>
      <span class="t">integer</span>
     </b>
    </span>
   </div>
   <p>
 The cron interval for the queue checking.</p>
   <div class="sigbox">
    <span class="sig" id="ProbePackages">global
     <b>ProbePackages ()
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Detect which packages have to be installed
 and return a descriptive string for a plain text pop-up.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">"" or "Foo will be installed.\nBar will be installed.\n"</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ReadMta">local
     <b>ReadMta ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Detect the MTA installed</p>
   <div class="sigbox">
    <span class="sig" id="RunFetchmailGlobally">local
     <b>RunFetchmailGlobally ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p></p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Whether rcfetchmail should run</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="Read">global
     <b>Read (block&lt;boolean&gt; abort)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Read all mail settings from the SCR</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">abort</span>
       </td>
       <td class="descbox">A block that can be called by Read to find
	      out whether abort is requested. Returns true if abort
	      was pressed.</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">True on success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ReadWithoutCallback">global
     <b>ReadWithoutCallback ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Wrapper for global Read function, without the callback argument</p>
   <div class="sigbox">
    <span class="sig" id="Fake">global
     <b>Fake ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Make up data for screnshots</p>
   <div class="sigbox">
    <span class="sig" id="WriteGeneral">global
     <b>WriteGeneral ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteMasquerading">global
     <b>WriteMasquerading ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteDownloading">global
     <b>WriteDownloading ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteAliasesAndVirtual">global
     <b>WriteAliasesAndVirtual ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteSmtpAuth">global
     <b>WriteSmtpAuth ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteFlush">global
     <b>WriteFlush ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteSuSEconfig">global
     <b>WriteSuSEconfig ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteServices">global
     <b>WriteServices ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Part of Write.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="Write">global
     <b>Write (block&lt;boolean&gt; abort)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Update the SCR according to mail settings</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">abort</span>
       </td>
       <td class="descbox">A block that can be called by Write to find
	      out whether abort is requested. Returns true if abort
	      was pressed.</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">True on success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteWithoutCallback">global
     <b>WriteWithoutCallback ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Wrapper for global Write function, without the callback argument</p>
   <div class="sigbox">
    <span class="sig" id="Import">global
     <b>Import (map Settings)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Get all mail settings from the first parameter
 (For use by autoinstallation.)</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">Settings</span>
       </td>
       <td class="descbox">The YCP structure to be imported.</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">True on success</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="Export">global
     <b>Export ()
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 Dump the mail settings to a single map
 (For use by autoinstallation.)</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Dumped settings (later acceptable by Import ())</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ListItem">local
     <b>ListItem (string title, any value, any index)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Summarizes a list of data</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">title</span>
       </td>
       <td class="descbox">passed to Summary::AddHeader</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">value</span>
       </td>
       <td class="descbox">a list (of scalars, lists or maps)</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">index</span>
       </td>
       <td class="descbox">if the entries are not scalars,
   use this index to get a scalar</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Summary-formatted description</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="Summary">global
     <b>Summary ()
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Summary</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">with summary of configuration</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="AutoPackages">global
     <b>AutoPackages ()
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 Return required packages for auto-installation</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">of packages to be installed and to be removed</td>
      </tr>
     </table>
    </dd>
   </dl>
  </div>
  <div class="footer">
   <hr />
   <i>YaST2 Developers Documentation</i>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
  </div>
 </body>
</html>

ACC SHELL 2018