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

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

eric ide

mercurial