Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EmailPage.html
src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EmailPage.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Preferences.ConfigurationPages.EmailPage</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Preferences.ConfigurationPages.EmailPage</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Email configuration page. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#EmailPage">EmailPage</a></td> | |
| 25 <td>Class implementing the Email configuration page.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#create">create</a></td> | |
| 34 <td>Module function to create the configuration page.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="EmailPage" ID="EmailPage"></a> | |
| 40 <h2>EmailPage</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the Email configuration page. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 ConfigurationPageBase, Ui_EmailPage | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#EmailPage.__init__">EmailPage</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#EmailPage.__checkGoogleMail">__checkGoogleMail</a></td> | |
| 67 <td>Private method to check the Google Mail availability and set the widgets accordingly.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EmailPage.__updatePortSpin">__updatePortSpin</a></td> | |
| 71 <td>Private slot to set the value of the port spin box depending upon the selected encryption method.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EmailPage.__updateTestButton">__updateTestButton</a></td> | |
| 75 <td>Private slot to update the enabled state of the test button.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EmailPage.on_googleCheckAgainButton_clicked">on_googleCheckAgainButton_clicked</a></td> | |
| 79 <td>Private slot to check again the availability of Google Mail.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EmailPage.on_googleHelpButton_clicked">on_googleHelpButton_clicked</a></td> | |
| 83 <td>Private slot to show some help text "how to turn on the Gmail API".</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#EmailPage.on_googleInstallButton_clicked">on_googleInstallButton_clicked</a></td> | |
| 87 <td>Private slot to install the required packages for use of Google Mail.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#EmailPage.on_mailAuthenticationGroup_toggled">on_mailAuthenticationGroup_toggled</a></td> | |
| 91 <td>Private slot to handle a change of the state of the authentication group.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#EmailPage.on_mailPasswordEdit_textChanged">on_mailPasswordEdit_textChanged</a></td> | |
| 95 <td>Private slot to handle a change of the text of the user edit.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#EmailPage.on_mailServerEdit_textChanged">on_mailServerEdit_textChanged</a></td> | |
| 99 <td>Private slot to handle a change of the text of the mail server edit.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#EmailPage.on_mailUserEdit_textChanged">on_mailUserEdit_textChanged</a></td> | |
| 103 <td>Private slot to handle a change of the text of the user edit.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#EmailPage.on_noEncryptionButton_toggled">on_noEncryptionButton_toggled</a></td> | |
| 107 <td>Private slot handling a change of no encryption button.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#EmailPage.on_testButton_clicked">on_testButton_clicked</a></td> | |
| 111 <td>Private slot to test the mail server login data.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#EmailPage.on_useSslButton_toggled">on_useSslButton_toggled</a></td> | |
| 115 <td>Private slot handling a change of SSL encryption button.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#EmailPage.on_useTlsButton_toggled">on_useTlsButton_toggled</a></td> | |
| 119 <td>Private slot handling a change of TLS encryption button.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#EmailPage.save">save</a></td> | |
| 123 <td>Public slot to save the Email configuration.</td> | |
| 124 </tr> | |
| 125 </table> | |
| 126 <h3>Static Methods</h3> | |
| 127 | |
| 128 <table> | |
| 129 <tr><td>None</td></tr> | |
| 130 </table> | |
| 131 | |
| 132 <a NAME="EmailPage.__init__" ID="EmailPage.__init__"></a> | |
| 133 <h4>EmailPage (Constructor)</h4> | |
| 134 <b>EmailPage</b>(<i></i>) | |
| 135 | |
| 136 <p> | |
| 137 Constructor | |
| 138 </p> | |
| 139 <a NAME="EmailPage.__checkGoogleMail" ID="EmailPage.__checkGoogleMail"></a> | |
| 140 <h4>EmailPage.__checkGoogleMail</h4> | |
| 141 <b>__checkGoogleMail</b>(<i></i>) | |
| 142 | |
| 143 <p> | |
| 144 Private method to check the Google Mail availability and set the | |
| 145 widgets accordingly. | |
| 146 </p> | |
| 147 <a NAME="EmailPage.__updatePortSpin" ID="EmailPage.__updatePortSpin"></a> | |
| 148 <h4>EmailPage.__updatePortSpin</h4> | |
| 149 <b>__updatePortSpin</b>(<i></i>) | |
| 150 | |
| 151 <p> | |
| 152 Private slot to set the value of the port spin box depending upon | |
| 153 the selected encryption method. | |
| 154 </p> | |
| 155 <a NAME="EmailPage.__updateTestButton" ID="EmailPage.__updateTestButton"></a> | |
| 156 <h4>EmailPage.__updateTestButton</h4> | |
| 157 <b>__updateTestButton</b>(<i></i>) | |
| 158 | |
| 159 <p> | |
| 160 Private slot to update the enabled state of the test button. | |
| 161 </p> | |
| 162 <a NAME="EmailPage.on_googleCheckAgainButton_clicked" ID="EmailPage.on_googleCheckAgainButton_clicked"></a> | |
| 163 <h4>EmailPage.on_googleCheckAgainButton_clicked</h4> | |
| 164 <b>on_googleCheckAgainButton_clicked</b>(<i></i>) | |
| 165 | |
| 166 <p> | |
| 167 Private slot to check again the availability of Google Mail. | |
| 168 </p> | |
| 169 <a NAME="EmailPage.on_googleHelpButton_clicked" ID="EmailPage.on_googleHelpButton_clicked"></a> | |
| 170 <h4>EmailPage.on_googleHelpButton_clicked</h4> | |
| 171 <b>on_googleHelpButton_clicked</b>(<i></i>) | |
| 172 | |
| 173 <p> | |
| 174 Private slot to show some help text "how to turn on the Gmail API". | |
| 175 </p> | |
| 176 <a NAME="EmailPage.on_googleInstallButton_clicked" ID="EmailPage.on_googleInstallButton_clicked"></a> | |
| 177 <h4>EmailPage.on_googleInstallButton_clicked</h4> | |
| 178 <b>on_googleInstallButton_clicked</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Private slot to install the required packages for use of Google Mail. | |
| 182 </p> | |
| 183 <a NAME="EmailPage.on_mailAuthenticationGroup_toggled" ID="EmailPage.on_mailAuthenticationGroup_toggled"></a> | |
| 184 <h4>EmailPage.on_mailAuthenticationGroup_toggled</h4> | |
| 185 <b>on_mailAuthenticationGroup_toggled</b>(<i>checked</i>) | |
| 186 | |
| 187 <p> | |
| 188 Private slot to handle a change of the state of the authentication | |
| 189 group. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>checked</i></dt> | |
| 194 <dd> | |
| 195 state of the group (boolean) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="EmailPage.on_mailPasswordEdit_textChanged" ID="EmailPage.on_mailPasswordEdit_textChanged"></a> | |
| 199 <h4>EmailPage.on_mailPasswordEdit_textChanged</h4> | |
| 200 <b>on_mailPasswordEdit_textChanged</b>(<i>txt</i>) | |
| 201 | |
| 202 <p> | |
| 203 Private slot to handle a change of the text of the user edit. | |
| 204 </p> | |
| 205 <dl> | |
| 206 | |
| 207 <dt><i>txt</i></dt> | |
| 208 <dd> | |
| 209 current text of the edit (string) | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="EmailPage.on_mailServerEdit_textChanged" ID="EmailPage.on_mailServerEdit_textChanged"></a> | |
| 213 <h4>EmailPage.on_mailServerEdit_textChanged</h4> | |
| 214 <b>on_mailServerEdit_textChanged</b>(<i>txt</i>) | |
| 215 | |
| 216 <p> | |
| 217 Private slot to handle a change of the text of the mail server edit. | |
| 218 </p> | |
| 219 <dl> | |
| 220 | |
| 221 <dt><i>txt</i> (str)</dt> | |
| 222 <dd> | |
| 223 current text of the edit (string) | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <a NAME="EmailPage.on_mailUserEdit_textChanged" ID="EmailPage.on_mailUserEdit_textChanged"></a> | |
| 227 <h4>EmailPage.on_mailUserEdit_textChanged</h4> | |
| 228 <b>on_mailUserEdit_textChanged</b>(<i>txt</i>) | |
| 229 | |
| 230 <p> | |
| 231 Private slot to handle a change of the text of the user edit. | |
| 232 </p> | |
| 233 <dl> | |
| 234 | |
| 235 <dt><i>txt</i></dt> | |
| 236 <dd> | |
| 237 current text of the edit (string) | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <a NAME="EmailPage.on_noEncryptionButton_toggled" ID="EmailPage.on_noEncryptionButton_toggled"></a> | |
| 241 <h4>EmailPage.on_noEncryptionButton_toggled</h4> | |
| 242 <b>on_noEncryptionButton_toggled</b>(<i>checked</i>) | |
| 243 | |
| 244 <p> | |
| 245 Private slot handling a change of no encryption button. | |
| 246 </p> | |
| 247 <dl> | |
| 248 | |
| 249 <dt><i>checked</i> (bool)</dt> | |
| 250 <dd> | |
| 251 current state of the button | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <a NAME="EmailPage.on_testButton_clicked" ID="EmailPage.on_testButton_clicked"></a> | |
| 255 <h4>EmailPage.on_testButton_clicked</h4> | |
| 256 <b>on_testButton_clicked</b>(<i></i>) | |
| 257 | |
| 258 <p> | |
| 259 Private slot to test the mail server login data. | |
| 260 </p> | |
| 261 <a NAME="EmailPage.on_useSslButton_toggled" ID="EmailPage.on_useSslButton_toggled"></a> | |
| 262 <h4>EmailPage.on_useSslButton_toggled</h4> | |
| 263 <b>on_useSslButton_toggled</b>(<i>checked</i>) | |
| 264 | |
| 265 <p> | |
| 266 Private slot handling a change of SSL encryption button. | |
| 267 </p> | |
| 268 <dl> | |
| 269 | |
| 270 <dt><i>checked</i> (bool)</dt> | |
| 271 <dd> | |
| 272 current state of the button | |
| 273 </dd> | |
| 274 </dl> | |
| 275 <a NAME="EmailPage.on_useTlsButton_toggled" ID="EmailPage.on_useTlsButton_toggled"></a> | |
| 276 <h4>EmailPage.on_useTlsButton_toggled</h4> | |
| 277 <b>on_useTlsButton_toggled</b>(<i>checked</i>) | |
| 278 | |
| 279 <p> | |
| 280 Private slot handling a change of TLS encryption button. | |
| 281 </p> | |
| 282 <dl> | |
| 283 | |
| 284 <dt><i>checked</i> (bool)</dt> | |
| 285 <dd> | |
| 286 current state of the button | |
| 287 </dd> | |
| 288 </dl> | |
| 289 <a NAME="EmailPage.save" ID="EmailPage.save"></a> | |
| 290 <h4>EmailPage.save</h4> | |
| 291 <b>save</b>(<i></i>) | |
| 292 | |
| 293 <p> | |
| 294 Public slot to save the Email configuration. | |
| 295 </p> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /> | |
| 298 <hr /> | |
| 299 <a NAME="create" ID="create"></a> | |
| 300 <h2>create</h2> | |
| 301 <b>create</b>(<i>dlg</i>) | |
| 302 | |
| 303 <p> | |
| 304 Module function to create the configuration page. | |
| 305 </p> | |
| 306 <dl> | |
| 307 | |
| 308 <dt><i>dlg</i></dt> | |
| 309 <dd> | |
| 310 reference to the configuration dialog | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <dl> | |
| 314 <dt>Return:</dt> | |
| 315 <dd> | |
| 316 reference to the instantiated page (ConfigurationPageBase) | |
| 317 </dd> | |
| 318 </dl> | |
| 319 <div align="right"><a href="#top">Up</a></div> | |
| 320 <hr /> | |
| 321 </body></html> |
