Documentation/Source/eric6.UI.EmailDialog.html

changeset 5769
944c04cec861
parent 3673
e26d7d0c1088
child 5788
b01d2c1e0973
--- a/Documentation/Source/eric6.UI.EmailDialog.html	Sun Jun 25 16:17:00 2017 +0200
+++ b/Documentation/Source/eric6.UI.EmailDialog.html	Mon Jun 26 19:31:49 2017 +0200
@@ -21,7 +21,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric6.UI.EmailDialog</h1>
 <p>
-Module implementing a dialog to send bug reports.
+Module implementing a dialog to send bug reports or feature requests.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#EmailDialog">EmailDialog</a></td>
-<td>Class implementing a dialog to send bug reports.</td>
+<td>Class implementing a dialog to send bug reports or feature requests.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -45,7 +45,7 @@
 <a NAME="EmailDialog" ID="EmailDialog"></a>
 <h2>EmailDialog</h2>
 <p>
-    Class implementing a dialog to send bug reports.
+    Class implementing a dialog to send bug reports or feature requests.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_EmailDialog
@@ -78,6 +78,9 @@
 <td><a href="#EmailDialog.__sendmail">__sendmail</a></td>
 <td>Private method to actually send the message.</td>
 </tr><tr>
+<td><a href="#EmailDialog.__sendmailGoogle">__sendmailGoogle</a></td>
+<td>Private method to actually send the message via Google Mail.</td>
+</tr><tr>
 <td><a href="#EmailDialog.attachFile">attachFile</a></td>
 <td>Public method to add an attachment.</td>
 </tr><tr>
@@ -96,6 +99,9 @@
 <td><a href="#EmailDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
 <td>Private slot to handle the Delete button.</td>
 </tr><tr>
+<td><a href="#EmailDialog.on_googleHelpButton_clicked">on_googleHelpButton_clicked</a></td>
+<td>Private slot to show some help text "how to turn on the Gmail API".</td>
+</tr><tr>
 <td><a href="#EmailDialog.on_message_textChanged">on_message_textChanged</a></td>
 <td>Private slot to handle the textChanged signal of the message edit.</td>
 </tr><tr>
@@ -131,7 +137,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-string containing the mail message
+prepared mail message
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+email.mime.text.MIMEMultipart
 </dd>
 </dl><a NAME="EmailDialog.__createSimpleMail" ID="EmailDialog.__createSimpleMail"></a>
 <h4>EmailDialog.__createSimpleMail</h4>
@@ -141,7 +152,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-string containing the mail message
+prepared mail message
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+email.mime.text.MIMEText
 </dd>
 </dl><a NAME="EmailDialog.__encodedHeader" ID="EmailDialog.__encodedHeader"></a>
 <h4>EmailDialog.__encodedHeader</h4>
@@ -188,6 +204,26 @@
 <dd>
 flag indicating success (boolean)
 </dd>
+</dl><a NAME="EmailDialog.__sendmailGoogle" ID="EmailDialog.__sendmailGoogle"></a>
+<h4>EmailDialog.__sendmailGoogle</h4>
+<b>__sendmailGoogle</b>(<i>msg</i>)
+<p>
+        Private method to actually send the message via Google Mail.
+</p><dl>
+<dt><i>message</i> (email.mime.text.MIMEBase)</dt>
+<dd>
+email message to be sent
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="EmailDialog.attachFile" ID="EmailDialog.attachFile"></a>
 <h4>EmailDialog.attachFile</h4>
 <b>attachFile</b>(<i>fname, deleteFile</i>)
@@ -237,6 +273,11 @@
 <b>on_deleteButton_clicked</b>(<i></i>)
 <p>
         Private slot to handle the Delete button.
+</p><a NAME="EmailDialog.on_googleHelpButton_clicked" ID="EmailDialog.on_googleHelpButton_clicked"></a>
+<h4>EmailDialog.on_googleHelpButton_clicked</h4>
+<b>on_googleHelpButton_clicked</b>(<i></i>)
+<p>
+        Private slot to show some help text "how to turn on the Gmail API".
 </p><a NAME="EmailDialog.on_message_textChanged" ID="EmailDialog.on_message_textChanged"></a>
 <h4>EmailDialog.on_message_textChanged</h4>
 <b>on_message_textChanged</b>(<i></i>)

eric ide

mercurial