|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.E5Network.E5GoogleMailHelpers</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.E5Network.E5GoogleMailHelpers</h1> |
|
23 <p> |
|
24 Module implementing some helpers for Google mail. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>APPLICATION_NAME</td></tr><tr><td>CLIENT_SECRET_FILE</td></tr><tr><td>RequiredPackages</td></tr><tr><td>SCOPES</td></tr><tr><td>TOKEN_FILE</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr><td>None</td></tr> |
|
33 </table> |
|
34 <h3>Functions</h3> |
|
35 <table> |
|
36 <tr> |
|
37 <td><a href="#getInstallCommand">getInstallCommand</a></td> |
|
38 <td>Module function to get the install command to get the Google mail support activated.</td> |
|
39 </tr><tr> |
|
40 <td><a href="#isClientSecretFileAvailable">isClientSecretFileAvailable</a></td> |
|
41 <td>Module function to check, if the client secret file has been installed.</td> |
|
42 </tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="getInstallCommand" ID="getInstallCommand"></a> |
|
46 <h2>getInstallCommand</h2> |
|
47 <b>getInstallCommand</b>(<i></i>) |
|
48 <p> |
|
49 Module function to get the install command to get the Google mail support |
|
50 activated. |
|
51 </p><dl> |
|
52 <dt>Returns:</dt> |
|
53 <dd> |
|
54 install command |
|
55 </dd> |
|
56 </dl><dl> |
|
57 <dt>Return Type:</dt> |
|
58 <dd> |
|
59 str |
|
60 </dd> |
|
61 </dl> |
|
62 <div align="right"><a href="#top">Up</a></div> |
|
63 <hr /><hr /> |
|
64 <a NAME="isClientSecretFileAvailable" ID="isClientSecretFileAvailable"></a> |
|
65 <h2>isClientSecretFileAvailable</h2> |
|
66 <b>isClientSecretFileAvailable</b>(<i></i>) |
|
67 <p> |
|
68 Module function to check, if the client secret file has been installed. |
|
69 </p><dl> |
|
70 <dt>Returns:</dt> |
|
71 <dd> |
|
72 flag indicating, that the credentials file is there |
|
73 </dd> |
|
74 </dl><dl> |
|
75 <dt>Return Type:</dt> |
|
76 <dd> |
|
77 bool |
|
78 </dd> |
|
79 </dl> |
|
80 <div align="right"><a href="#top">Up</a></div> |
|
81 <hr /> |
|
82 </body></html> |