ACC SHELL

Path : /usr/share/doc/packages/yast2-mail/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-mail/autodocs/ui.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">
   include/mail/ui.ycp
</td>
     </tr>
     <tr>
      <td>
   User interface 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>

 All user interface functions.


       <h1>Imports</h1>
       <ul>
        <li>CWMFirewallInterfaces</li>
        <li>Hostname</li>
        <li>Label</li>
        <li>Mail</li>
        <li>MailAliases</li>
        <li>Mode</li>
        <li>Package</li>
        <li>Popup</li>
        <li>Progress</li>
        <li>Sequencer</li>
        <li>Wizard</li>
       </ul>
       <h1>Includes</h1>
       <ul>
        <li>mail/helps.ycp</li>
        <li>mail/wj.ycp</li>
       </ul>
       <h1>Local Variables</h1>
       <ul>
        <li>
         <a href="#preselect_connection_type">preselect_connection_type</a>
        </li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#AliasPopup">AliasPopup (map defaultv, list&lt;map&gt; existing)</a>
        </li>
        <li>
         <a href="#AliasesDialog">AliasesDialog ()</a>
        </li>
        <li>
         <a href="#ConfirmDialog">ConfirmDialog ()</a>
        </li>
        <li>
         <a href="#ConnectionTypeDialog">ConnectionTypeDialog ()</a>
        </li>
        <li>
         <a href="#DownloadingDialog">DownloadingDialog ()</a>
        </li>
        <li>
         <a href="#FetchmailPopup">FetchmailPopup (map defaultv, list&lt;map&gt; existing)</a>
        </li>
        <li>
         <a href="#IncomingDialog">IncomingDialog ()</a>
        </li>
        <li>
         <a href="#JustNext">JustNext ()</a>
        </li>
        <li>
         <a href="#MailAutoSequence">MailAutoSequence ()</a>
        </li>
        <li>
         <a href="#MailSequence">MailSequence ()</a>
        </li>
        <li>
         <a href="#MasqueradeUserPopup">MasqueradeUserPopup (map defaultv, list&lt;map&gt; existing)</a>
        </li>
        <li>
         <a href="#MtaSelectionDialog">MtaSelectionDialog ()</a>
        </li>
        <li>
         <a href="#OutgoingAuthOptions">OutgoingAuthOptions ()</a>
        </li>
        <li>
         <a href="#OutgoingDetailsDialog">OutgoingDetailsDialog ()</a>
        </li>
        <li>
         <a href="#OutgoingDialog">OutgoingDialog ()</a>
        </li>
        <li>
         <a href="#ReadDialog">ReadDialog ()</a>
        </li>
        <li>
         <a href="#VirtualDialog">VirtualDialog ()</a>
        </li>
        <li>
         <a href="#WriteDialog">WriteDialog ()</a>
        </li>
        <li>
         <a href="#check_mail_address">check_mail_address (string address)</a>
        </li>
        <li>
         <a href="#check_username">check_username (string username)</a>
        </li>
        <li>
         <a href="#valid_username">valid_username ()</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="ReadDialog">local
     <b>ReadDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Read settings dialog</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ConfirmDialog">local
     <b>ConfirmDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Confirmation dialog before saving and installing needed packages</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="WriteDialog">local
     <b>WriteDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Write settings dialog</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="MtaSelectionDialog">local
     <b>MtaSelectionDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 MTA selection dialog
 (only for autoinstallation, otherwise probed in Mail::Read)</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="preselect_connection_type">local
     <b>preselect_connection_type
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 A command line argument can override what is read from SCR.
 Used when starting mail from lan/modem.</p>
   <div class="sigbox">
    <span class="sig" id="ConnectionTypeDialog">local
     <b>ConnectionTypeDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D1</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort, `next or `none</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="OutgoingDialog">local
     <b>OutgoingDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D2</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort, `next or `outgoing_details</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="IncomingDialog">local
     <b>IncomingDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D2</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort, `next or `outgoing_details</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="check_username">local
     <b>check_username (string username)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 (taken from y2c_users ui.ycp)</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">username</span>
       </td>
       <td class="descbox">a string</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">Whether a string contains only valid user name characters</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="valid_username">local
     <b>valid_username ()
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 (taken from y2c_users ui.ycp)</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Describe a valid username</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="check_mail_address">local
     <b>check_mail_address (string address)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 See RFC 2822, 3.4
 But for now, no-spaces@valid_domainname</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">address</span>
       </td>
       <td class="descbox">an address to check</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">valid?</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="MasqueradeUserPopup">local
     <b>MasqueradeUserPopup (map defaultv, list&lt;map&gt; existing)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 D2.1.1
 Used for adding and editing a user masquerading entry.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">defaultv</span>
       </td>
       <td class="descbox">$["user": "address":] or just $[]</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">existing</span>
       </td>
       <td class="descbox">current masqueading list</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">$["comment": "", "user": "address":] or $[] on cancel</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="OutgoingDetailsDialog">local
     <b>OutgoingDetailsDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D2.1</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="OutgoingAuthOptions">local
     <b>OutgoingAuthOptions ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D2.2
 Outgoing server authentification</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FetchmailPopup">local
     <b>FetchmailPopup (map defaultv, list&lt;map&gt; existing)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 D3.1</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">defaultv</span>
       </td>
       <td class="descbox">$[server:, protocol:, remote_user:, local_user:, password:, ...]</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">existing</span>
       </td>
       <td class="descbox">unused</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">edited data (with no other fields) or $[] on cancel</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="DownloadingDialog">local
     <b>DownloadingDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D3</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="AliasPopup">local
     <b>AliasPopup (map defaultv, list&lt;map&gt; existing)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 D1.1.1, 1.2.1
 Used for adding and editing an alias/virtual domain entry.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">defaultv</span>
       </td>
       <td class="descbox">$["alias": "destinations": ?comment] or just $[]</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">existing</span>
       </td>
       <td class="descbox">current entry list</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">$["comment": ""?, "alias": "destinations":] or $[] on cancel</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="AliasesDialog">local
     <b>AliasesDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D1.1</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="VirtualDialog">local
     <b>VirtualDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 D1.2</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="JustNext">local
     <b>JustNext ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 A Wizard Sequencer helper</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="MailSequence">local
     <b>MailSequence ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Whole configuration of mail</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="MailAutoSequence">local
     <b>MailAutoSequence ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Whole configuration of mail but without reading and writing.
 MTA is selected first.
 For use with autoinstallation.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`back, `abort or `next</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