src/eric7/Documentation/Source/eric7.EricNetwork.EricGoogleMailHelpers.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9427
905e7af29101
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricNetwork.EricGoogleMailHelpers</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.EricNetwork.EricGoogleMailHelpers</h1>
10
11 <p>
12 Module implementing some helpers for Google mail.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <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>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22 <tr><td>None</td></tr>
23 </table>
24 <h3>Functions</h3>
25
26 <table>
27
28 <tr>
29 <td><a href="#getInstallCommand">getInstallCommand</a></td>
30 <td>Module function to get the install command to get the Google mail support activated.</td>
31 </tr>
32 <tr>
33 <td><a href="#isClientSecretFileAvailable">isClientSecretFileAvailable</a></td>
34 <td>Module function to check, if the client secret file has been installed.</td>
35 </tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="getInstallCommand" ID="getInstallCommand"></a>
40 <h2>getInstallCommand</h2>
41 <b>getInstallCommand</b>(<i></i>)
42
43 <p>
44 Module function to get the install command to get the Google mail support
45 activated.
46 </p>
47 <dl>
48 <dt>Return:</dt>
49 <dd>
50 install command
51 </dd>
52 </dl>
53 <dl>
54 <dt>Return Type:</dt>
55 <dd>
56 str
57 </dd>
58 </dl>
59 <div align="right"><a href="#top">Up</a></div>
60 <hr />
61 <hr />
62 <a NAME="isClientSecretFileAvailable" ID="isClientSecretFileAvailable"></a>
63 <h2>isClientSecretFileAvailable</h2>
64 <b>isClientSecretFileAvailable</b>(<i></i>)
65
66 <p>
67 Module function to check, if the client secret file has been installed.
68 </p>
69 <dl>
70 <dt>Return:</dt>
71 <dd>
72 flag indicating, that the credentials file is there
73 </dd>
74 </dl>
75 <dl>
76 <dt>Return Type:</dt>
77 <dd>
78 bool
79 </dd>
80 </dl>
81 <div align="right"><a href="#top">Up</a></div>
82 <hr />
83 </body></html>

eric ide

mercurial