eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.EmailPage.html

<!DOCTYPE html>
<html><head>
<title>eric6.Preferences.ConfigurationPages.EmailPage</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.Preferences.ConfigurationPages.EmailPage</h1>

<p>
Module implementing the Email configuration page.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EmailPage">EmailPage</a></td>
<td>Class implementing the Email configuration page.</td>
</tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#create">create</a></td>
<td>Module function to create the configuration page.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="EmailPage" ID="EmailPage"></a>
<h2>EmailPage</h2>

<p>
    Class implementing the Email configuration page.
</p>
<h3>Derived from</h3>
ConfigurationPageBase, Ui_EmailPage
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#EmailPage.__init__">EmailPage</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EmailPage.__checkGoogleMail">__checkGoogleMail</a></td>
<td>Private method to check the Google Mail availability and set the widgets accordingly.</td>
</tr>
<tr>
<td><a href="#EmailPage.__updatePortSpin">__updatePortSpin</a></td>
<td>Private slot to set the value of the port spin box depending upon the selected encryption method.</td>
</tr>
<tr>
<td><a href="#EmailPage.__updateTestButton">__updateTestButton</a></td>
<td>Private slot to update the enabled state of the test button.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_googleCheckAgainButton_clicked">on_googleCheckAgainButton_clicked</a></td>
<td>Private slot to check again the availability of Google Mail.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_googleHelpButton_clicked">on_googleHelpButton_clicked</a></td>
<td>Private slot to show some help text "how to turn on the Gmail API".</td>
</tr>
<tr>
<td><a href="#EmailPage.on_googleInstallButton_clicked">on_googleInstallButton_clicked</a></td>
<td>Private slot to install the required packages for use of Google Mail.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_mailAuthenticationGroup_toggled">on_mailAuthenticationGroup_toggled</a></td>
<td>Private slot to handle a change of the state of the authentication group.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_mailPasswordEdit_textChanged">on_mailPasswordEdit_textChanged</a></td>
<td>Private slot to handle a change of the text of the user edit.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_mailServerEdit_textChanged">on_mailServerEdit_textChanged</a></td>
<td>Private slot to handle a change of the text of the mail server edit.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_mailUserEdit_textChanged">on_mailUserEdit_textChanged</a></td>
<td>Private slot to handle a change of the text of the user edit.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_noEncryptionButton_toggled">on_noEncryptionButton_toggled</a></td>
<td>Private slot handling a change of no encryption button.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_testButton_clicked">on_testButton_clicked</a></td>
<td>Private slot to test the mail server login data.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_useSslButton_toggled">on_useSslButton_toggled</a></td>
<td>Private slot handling a change of SSL encryption button.</td>
</tr>
<tr>
<td><a href="#EmailPage.on_useTlsButton_toggled">on_useTlsButton_toggled</a></td>
<td>Private slot handling a change of TLS encryption button.</td>
</tr>
<tr>
<td><a href="#EmailPage.save">save</a></td>
<td>Public slot to save the Email configuration.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EmailPage.__init__" ID="EmailPage.__init__"></a>
<h4>EmailPage (Constructor)</h4>
<b>EmailPage</b>(<i></i>)

<p>
        Constructor
</p>
<a NAME="EmailPage.__checkGoogleMail" ID="EmailPage.__checkGoogleMail"></a>
<h4>EmailPage.__checkGoogleMail</h4>
<b>__checkGoogleMail</b>(<i></i>)

<p>
        Private method to check the Google Mail availability and set the
        widgets accordingly.
</p>
<a NAME="EmailPage.__updatePortSpin" ID="EmailPage.__updatePortSpin"></a>
<h4>EmailPage.__updatePortSpin</h4>
<b>__updatePortSpin</b>(<i></i>)

<p>
        Private slot to set the value of the port spin box depending upon
        the selected encryption method.
</p>
<a NAME="EmailPage.__updateTestButton" ID="EmailPage.__updateTestButton"></a>
<h4>EmailPage.__updateTestButton</h4>
<b>__updateTestButton</b>(<i></i>)

<p>
        Private slot to update the enabled state of the test button.
</p>
<a NAME="EmailPage.on_googleCheckAgainButton_clicked" ID="EmailPage.on_googleCheckAgainButton_clicked"></a>
<h4>EmailPage.on_googleCheckAgainButton_clicked</h4>
<b>on_googleCheckAgainButton_clicked</b>(<i></i>)

<p>
        Private slot to check again the availability of Google Mail.
</p>
<a NAME="EmailPage.on_googleHelpButton_clicked" ID="EmailPage.on_googleHelpButton_clicked"></a>
<h4>EmailPage.on_googleHelpButton_clicked</h4>
<b>on_googleHelpButton_clicked</b>(<i></i>)

<p>
        Private slot to show some help text "how to turn on the Gmail API".
</p>
<a NAME="EmailPage.on_googleInstallButton_clicked" ID="EmailPage.on_googleInstallButton_clicked"></a>
<h4>EmailPage.on_googleInstallButton_clicked</h4>
<b>on_googleInstallButton_clicked</b>(<i></i>)

<p>
        Private slot to install the required packages for use of Google Mail.
</p>
<a NAME="EmailPage.on_mailAuthenticationGroup_toggled" ID="EmailPage.on_mailAuthenticationGroup_toggled"></a>
<h4>EmailPage.on_mailAuthenticationGroup_toggled</h4>
<b>on_mailAuthenticationGroup_toggled</b>(<i>checked</i>)

<p>
        Private slot to handle a change of the state of the authentication
        group.
</p>
<dl>

<dt><i>checked</i></dt>
<dd>
state of the group (boolean)
</dd>
</dl>
<a NAME="EmailPage.on_mailPasswordEdit_textChanged" ID="EmailPage.on_mailPasswordEdit_textChanged"></a>
<h4>EmailPage.on_mailPasswordEdit_textChanged</h4>
<b>on_mailPasswordEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the text of the user edit.
</p>
<dl>

<dt><i>txt</i></dt>
<dd>
current text of the edit (string)
</dd>
</dl>
<a NAME="EmailPage.on_mailServerEdit_textChanged" ID="EmailPage.on_mailServerEdit_textChanged"></a>
<h4>EmailPage.on_mailServerEdit_textChanged</h4>
<b>on_mailServerEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the text of the mail server edit.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
current text of the edit (string)
</dd>
</dl>
<a NAME="EmailPage.on_mailUserEdit_textChanged" ID="EmailPage.on_mailUserEdit_textChanged"></a>
<h4>EmailPage.on_mailUserEdit_textChanged</h4>
<b>on_mailUserEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot to handle a change of the text of the user edit.
</p>
<dl>

<dt><i>txt</i></dt>
<dd>
current text of the edit (string)
</dd>
</dl>
<a NAME="EmailPage.on_noEncryptionButton_toggled" ID="EmailPage.on_noEncryptionButton_toggled"></a>
<h4>EmailPage.on_noEncryptionButton_toggled</h4>
<b>on_noEncryptionButton_toggled</b>(<i>checked</i>)

<p>
        Private slot handling a change of no encryption button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
current state of the button
</dd>
</dl>
<a NAME="EmailPage.on_testButton_clicked" ID="EmailPage.on_testButton_clicked"></a>
<h4>EmailPage.on_testButton_clicked</h4>
<b>on_testButton_clicked</b>(<i></i>)

<p>
        Private slot to test the mail server login data.
</p>
<a NAME="EmailPage.on_useSslButton_toggled" ID="EmailPage.on_useSslButton_toggled"></a>
<h4>EmailPage.on_useSslButton_toggled</h4>
<b>on_useSslButton_toggled</b>(<i>checked</i>)

<p>
        Private slot handling a change of SSL encryption button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
current state of the button
</dd>
</dl>
<a NAME="EmailPage.on_useTlsButton_toggled" ID="EmailPage.on_useTlsButton_toggled"></a>
<h4>EmailPage.on_useTlsButton_toggled</h4>
<b>on_useTlsButton_toggled</b>(<i>checked</i>)

<p>
        Private slot handling a change of TLS encryption button.
</p>
<dl>

<dt><i>checked</i> (bool)</dt>
<dd>
current state of the button
</dd>
</dl>
<a NAME="EmailPage.save" ID="EmailPage.save"></a>
<h4>EmailPage.save</h4>
<b>save</b>(<i></i>)

<p>
        Public slot to save the Email configuration.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="create" ID="create"></a>
<h2>create</h2>
<b>create</b>(<i>dlg</i>)

<p>
    Module function to create the configuration page.
</p>
<dl>

<dt><i>dlg</i></dt>
<dd>
reference to the configuration dialog
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated page (ConfigurationPageBase)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>