tip/src/eric7/Documentation/Source/eric7.EricNetwork.EricGoogleMail.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricNetwork.EricGoogleMail</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricNetwork.EricGoogleMail</h1>
<p>
Module implementing a dialog to send bug reports.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricGoogleMail">EricGoogleMail</a></td>
<td>Class implementing the logic to send emails via Google Mail.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#GoogleMailHelp">GoogleMailHelp</a></td>
<td>Module function to get some help about how to enable the Google Mail OAuth2 service.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="EricGoogleMail" ID="EricGoogleMail"></a>
<h2>EricGoogleMail</h2>
<p>
    Class implementing the logic to send emails via Google Mail.
</p>

<h3>Signals</h3>
<dl>

<dt>sendResult(bool, str)</dt>
<dd>
emitted to indicate the transmission result
        and a result message
</dd>
</dl>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#EricGoogleMail.__init__">EricGoogleMail</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricGoogleMail.__doSendMessages">__doSendMessages</a></td>
<td>Private method to send all queued messages.</td>
</tr>
<tr>
<td><a href="#EricGoogleMail.__loadCredentials">__loadCredentials</a></td>
<td>Private method to load credentials from the token file.</td>
</tr>
<tr>
<td><a href="#EricGoogleMail.__prepareMessage">__prepareMessage</a></td>
<td>Private method to prepare the message for sending.</td>
</tr>
<tr>
<td><a href="#EricGoogleMail.__saveCredentials">__saveCredentials</a></td>
<td>Private method to save credentials to the token file.</td>
</tr>
<tr>
<td><a href="#EricGoogleMail.__startSession">__startSession</a></td>
<td>Private method to start an authorized session and optionally execute the authorization flow.</td>
</tr>
<tr>
<td><a href="#EricGoogleMail.sendMessage">sendMessage</a></td>
<td>Public method to send a message via Google Mail.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="EricGoogleMail.__init__" ID="EricGoogleMail.__init__"></a>
<h4>EricGoogleMail (Constructor)</h4>
<b>EricGoogleMail</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<a NAME="EricGoogleMail.__doSendMessages" ID="EricGoogleMail.__doSendMessages"></a>
<h4>EricGoogleMail.__doSendMessages</h4>
<b>__doSendMessages</b>(<i></i>)
<p>
        Private method to send all queued messages.
</p>

<a NAME="EricGoogleMail.__loadCredentials" ID="EricGoogleMail.__loadCredentials"></a>
<h4>EricGoogleMail.__loadCredentials</h4>
<b>__loadCredentials</b>(<i></i>)
<p>
        Private method to load credentials from the token file.
</p>

<dl>
<dt>Return:</dt>
<dd>
created credentials object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
Credentials
</dd>
</dl>
<a NAME="EricGoogleMail.__prepareMessage" ID="EricGoogleMail.__prepareMessage"></a>
<h4>EricGoogleMail.__prepareMessage</h4>
<b>__prepareMessage</b>(<i>message</i>)
<p>
        Private method to prepare the message for sending.
</p>

<dl>

<dt><i>message</i> (email.mime.text.MIMEBase)</dt>
<dd>
message to be prepared
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
prepared message dictionary
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="EricGoogleMail.__saveCredentials" ID="EricGoogleMail.__saveCredentials"></a>
<h4>EricGoogleMail.__saveCredentials</h4>
<b>__saveCredentials</b>(<i>credentials</i>)
<p>
        Private method to save credentials to the token file.
</p>

<dl>

<dt><i>credentials</i> (Credentials)</dt>
<dd>
credentials to be saved
</dd>
</dl>
<a NAME="EricGoogleMail.__startSession" ID="EricGoogleMail.__startSession"></a>
<h4>EricGoogleMail.__startSession</h4>
<b>__startSession</b>(<i></i>)
<p>
        Private method to start an authorized session and optionally execute the
        authorization flow.
</p>

<a NAME="EricGoogleMail.sendMessage" ID="EricGoogleMail.sendMessage"></a>
<h4>EricGoogleMail.sendMessage</h4>
<b>sendMessage</b>(<i>message</i>)
<p>
        Public method to send a message via Google Mail.
</p>

<dl>

<dt><i>message</i> (email.mime.text.MIMEBase)</dt>
<dd>
email message to be sent
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="GoogleMailHelp" ID="GoogleMailHelp"></a>
<h2>GoogleMailHelp</h2>
<b>GoogleMailHelp</b>(<i></i>)
<p>
    Module function to get some help about how to enable the Google Mail
    OAuth2 service.
</p>

<dl>
<dt>Return:</dt>
<dd>
help text
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>