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

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

eric ide

mercurial