--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.EricNetwork.EricGoogleMailHelpers.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,97 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricNetwork.EricGoogleMailHelpers</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.EricNetwork.EricGoogleMailHelpers</h1> + +<p> +Module implementing some helpers for Google mail. +</p> +<h3>Global Attributes</h3> + +<table> +<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> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#getInstallCommand">getInstallCommand</a></td> +<td>Module function to get the install command to get the Google mail support activated.</td> +</tr> +<tr> +<td><a href="#isClientSecretFileAvailable">isClientSecretFileAvailable</a></td> +<td>Module function to check, if the client secret file has been installed.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="getInstallCommand" ID="getInstallCommand"></a> +<h2>getInstallCommand</h2> +<b>getInstallCommand</b>(<i></i>) + +<p> + Module function to get the install command to get the Google mail support + activated. +</p> +<dl> +<dt>Return:</dt> +<dd> +install command +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="isClientSecretFileAvailable" ID="isClientSecretFileAvailable"></a> +<h2>isClientSecretFileAvailable</h2> +<b>isClientSecretFileAvailable</b>(<i></i>) + +<p> + Module function to check, if the client secret file has been installed. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating, that the credentials file is there +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file