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

changeset 6942
2602857055c5
parent 6828
bb6667ea9ae7
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Preferences.ConfigurationPages.EmailPage</h1>
23 <p>
24 Module implementing the Email configuration page.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#EmailPage">EmailPage</a></td>
34 <td>Class implementing the Email configuration page.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr>
40 <td><a href="#create">create</a></td>
41 <td>Module function to create the configuration page.</td>
42 </tr>
43 </table>
44 <hr /><hr />
45 <a NAME="EmailPage" ID="EmailPage"></a>
46 <h2>EmailPage</h2>
47 <p>
48 Class implementing the Email configuration page.
49 </p>
50 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_EmailPage
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#EmailPage.__init__">EmailPage</a></td>
64 <td>Constructor</td>
65 </tr><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><tr>
69 <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>
71 </tr><tr>
72 <td><a href="#EmailPage.__updateTestButton">__updateTestButton</a></td>
73 <td>Private slot to update the enabled state of the test button.</td>
74 </tr><tr>
75 <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>
77 </tr><tr>
78 <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>
80 </tr><tr>
81 <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>
83 </tr><tr>
84 <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>
86 </tr><tr>
87 <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>
89 </tr><tr>
90 <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>
92 </tr><tr>
93 <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>
95 </tr><tr>
96 <td><a href="#EmailPage.on_noEncryptionButton_toggled">on_noEncryptionButton_toggled</a></td>
97 <td>Private slot handling a change of no encryption button.</td>
98 </tr><tr>
99 <td><a href="#EmailPage.on_testButton_clicked">on_testButton_clicked</a></td>
100 <td>Private slot to test the mail server login data.</td>
101 </tr><tr>
102 <td><a href="#EmailPage.on_useSslButton_toggled">on_useSslButton_toggled</a></td>
103 <td>Private slot handling a change of SSL encryption button.</td>
104 </tr><tr>
105 <td><a href="#EmailPage.on_useTlsButton_toggled">on_useTlsButton_toggled</a></td>
106 <td>Private slot handling a change of TLS encryption button.</td>
107 </tr><tr>
108 <td><a href="#EmailPage.save">save</a></td>
109 <td>Public slot to save the Email configuration.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="EmailPage.__init__" ID="EmailPage.__init__"></a>
117 <h4>EmailPage (Constructor)</h4>
118 <b>EmailPage</b>(<i></i>)
119 <p>
120 Constructor
121 </p><a NAME="EmailPage.__checkGoogleMail" ID="EmailPage.__checkGoogleMail"></a>
122 <h4>EmailPage.__checkGoogleMail</h4>
123 <b>__checkGoogleMail</b>(<i></i>)
124 <p>
125 Private method to check the Google Mail availability and set the
126 widgets accordingly.
127 </p><a NAME="EmailPage.__updatePortSpin" ID="EmailPage.__updatePortSpin"></a>
128 <h4>EmailPage.__updatePortSpin</h4>
129 <b>__updatePortSpin</b>(<i></i>)
130 <p>
131 Private slot to set the value of the port spin box depending upon
132 the selected encryption method.
133 </p><a NAME="EmailPage.__updateTestButton" ID="EmailPage.__updateTestButton"></a>
134 <h4>EmailPage.__updateTestButton</h4>
135 <b>__updateTestButton</b>(<i></i>)
136 <p>
137 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>
139 <h4>EmailPage.on_googleCheckAgainButton_clicked</h4>
140 <b>on_googleCheckAgainButton_clicked</b>(<i></i>)
141 <p>
142 Private slot to check again the availability of Google Mail.
143 </p><a NAME="EmailPage.on_googleHelpButton_clicked" ID="EmailPage.on_googleHelpButton_clicked"></a>
144 <h4>EmailPage.on_googleHelpButton_clicked</h4>
145 <b>on_googleHelpButton_clicked</b>(<i></i>)
146 <p>
147 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>
149 <h4>EmailPage.on_googleInstallButton_clicked</h4>
150 <b>on_googleInstallButton_clicked</b>(<i></i>)
151 <p>
152 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>
154 <h4>EmailPage.on_mailAuthenticationGroup_toggled</h4>
155 <b>on_mailAuthenticationGroup_toggled</b>(<i>checked</i>)
156 <p>
157 Private slot to handle a change of the state of the authentication
158 group.
159 </p><dl>
160 <dt><i>checked</i></dt>
161 <dd>
162 state of the group (boolean)
163 </dd>
164 </dl><a NAME="EmailPage.on_mailPasswordEdit_textChanged" ID="EmailPage.on_mailPasswordEdit_textChanged"></a>
165 <h4>EmailPage.on_mailPasswordEdit_textChanged</h4>
166 <b>on_mailPasswordEdit_textChanged</b>(<i>txt</i>)
167 <p>
168 Private slot to handle a change of the text of the user edit.
169 </p><dl>
170 <dt><i>txt</i></dt>
171 <dd>
172 current text of the edit (string)
173 </dd>
174 </dl><a NAME="EmailPage.on_mailServerEdit_textChanged" ID="EmailPage.on_mailServerEdit_textChanged"></a>
175 <h4>EmailPage.on_mailServerEdit_textChanged</h4>
176 <b>on_mailServerEdit_textChanged</b>(<i>txt</i>)
177 <p>
178 Private slot to handle a change of the text of the mail server edit.
179 </p><dl>
180 <dt><i>txt</i> (str)</dt>
181 <dd>
182 current text of the edit (string)
183 </dd>
184 </dl><a NAME="EmailPage.on_mailUserEdit_textChanged" ID="EmailPage.on_mailUserEdit_textChanged"></a>
185 <h4>EmailPage.on_mailUserEdit_textChanged</h4>
186 <b>on_mailUserEdit_textChanged</b>(<i>txt</i>)
187 <p>
188 Private slot to handle a change of the text of the user edit.
189 </p><dl>
190 <dt><i>txt</i></dt>
191 <dd>
192 current text of the edit (string)
193 </dd>
194 </dl><a NAME="EmailPage.on_noEncryptionButton_toggled" ID="EmailPage.on_noEncryptionButton_toggled"></a>
195 <h4>EmailPage.on_noEncryptionButton_toggled</h4>
196 <b>on_noEncryptionButton_toggled</b>(<i>checked</i>)
197 <p>
198 Private slot handling a change of no encryption button.
199 </p><dl>
200 <dt><i>checked</i> (bool)</dt>
201 <dd>
202 current state of the button
203 </dd>
204 </dl><a NAME="EmailPage.on_testButton_clicked" ID="EmailPage.on_testButton_clicked"></a>
205 <h4>EmailPage.on_testButton_clicked</h4>
206 <b>on_testButton_clicked</b>(<i></i>)
207 <p>
208 Private slot to test the mail server login data.
209 </p><a NAME="EmailPage.on_useSslButton_toggled" ID="EmailPage.on_useSslButton_toggled"></a>
210 <h4>EmailPage.on_useSslButton_toggled</h4>
211 <b>on_useSslButton_toggled</b>(<i>checked</i>)
212 <p>
213 Private slot handling a change of SSL encryption button.
214 </p><dl>
215 <dt><i>checked</i> (bool)</dt>
216 <dd>
217 current state of the button
218 </dd>
219 </dl><a NAME="EmailPage.on_useTlsButton_toggled" ID="EmailPage.on_useTlsButton_toggled"></a>
220 <h4>EmailPage.on_useTlsButton_toggled</h4>
221 <b>on_useTlsButton_toggled</b>(<i>checked</i>)
222 <p>
223 Private slot handling a change of TLS encryption button.
224 </p><dl>
225 <dt><i>checked</i> (bool)</dt>
226 <dd>
227 current state of the button
228 </dd>
229 </dl><a NAME="EmailPage.save" ID="EmailPage.save"></a>
230 <h4>EmailPage.save</h4>
231 <b>save</b>(<i></i>)
232 <p>
233 Public slot to save the Email configuration.
234 </p>
235 <div align="right"><a href="#top">Up</a></div>
236 <hr /><hr />
237 <a NAME="create" ID="create"></a>
238 <h2>create</h2>
239 <b>create</b>(<i>dlg</i>)
240 <p>
241 Module function to create the configuration page.
242 </p><dl>
243 <dt><i>dlg</i></dt>
244 <dd>
245 reference to the configuration dialog
246 </dd>
247 </dl><dl>
248 <dt>Returns:</dt>
249 <dd>
250 reference to the instantiated page (ConfigurationPageBase)
251 </dd>
252 </dl>
253 <div align="right"><a href="#top">Up</a></div>
254 <hr />
255 </body></html>

eric ide

mercurial