Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.E5Network.E5GoogleMail.html
Documentation/Source/eric6.E5Network.E5GoogleMail.html
- changeset 5769
- 944c04cec861
- child 6561
- ca224a174b4f
equal
deleted
inserted
replaced
| 5768:6f4d7d02cb1e | 5769:944c04cec861 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.E5Network.E5GoogleMail</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.E5GoogleMail</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to send bug reports. | |
| 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>SCOPES</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="#GoogleMailHelp">GoogleMailHelp</a></td> | |
| 38 <td>Module function to get some help about how to enable the Google Mail OAuth2 service.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#GoogleMailSendMessage">GoogleMailSendMessage</a></td> | |
| 41 <td>Module function to send an email message via Google Mail.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#_prepareMessage_v2">_prepareMessage_v2</a></td> | |
| 44 <td>Module function to prepare the message for sending (Python2 Variant).</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#_prepareMessage_v3">_prepareMessage_v3</a></td> | |
| 47 <td>Module function to prepare the message for sending (Python2 Variant).</td> | |
| 48 </tr><tr> | |
| 49 <td><a href="#getCredentials">getCredentials</a></td> | |
| 50 <td>Module function to get the Google credentials.</td> | |
| 51 </tr> | |
| 52 </table> | |
| 53 <hr /><hr /> | |
| 54 <a NAME="GoogleMailHelp" ID="GoogleMailHelp"></a> | |
| 55 <h2>GoogleMailHelp</h2> | |
| 56 <b>GoogleMailHelp</b>(<i></i>) | |
| 57 <p> | |
| 58 Module function to get some help about how to enable the Google Mail | |
| 59 OAuth2 service. | |
| 60 </p><dl> | |
| 61 <dt>Returns:</dt> | |
| 62 <dd> | |
| 63 help text | |
| 64 </dd> | |
| 65 </dl><dl> | |
| 66 <dt>Return Type:</dt> | |
| 67 <dd> | |
| 68 str | |
| 69 </dd> | |
| 70 </dl> | |
| 71 <div align="right"><a href="#top">Up</a></div> | |
| 72 <hr /><hr /> | |
| 73 <a NAME="GoogleMailSendMessage" ID="GoogleMailSendMessage"></a> | |
| 74 <h2>GoogleMailSendMessage</h2> | |
| 75 <b>GoogleMailSendMessage</b>(<i>message</i>) | |
| 76 <p> | |
| 77 Module function to send an email message via Google Mail. | |
| 78 </p><dl> | |
| 79 <dt><i>message</i> (email.mime.text.MIMEBase)</dt> | |
| 80 <dd> | |
| 81 email message to be sent | |
| 82 </dd> | |
| 83 </dl><dl> | |
| 84 <dt>Returns:</dt> | |
| 85 <dd> | |
| 86 tuple containing a success flag and a result or error message | |
| 87 </dd> | |
| 88 </dl><dl> | |
| 89 <dt>Return Type:</dt> | |
| 90 <dd> | |
| 91 tuple of (bool, str) | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <div align="right"><a href="#top">Up</a></div> | |
| 95 <hr /><hr /> | |
| 96 <a NAME="_prepareMessage_v2" ID="_prepareMessage_v2"></a> | |
| 97 <h2>_prepareMessage_v2</h2> | |
| 98 <b>_prepareMessage_v2</b>(<i>message</i>) | |
| 99 <p> | |
| 100 Module function to prepare the message for sending (Python2 Variant). | |
| 101 </p><dl> | |
| 102 <dt><i>message</i> (email.mime.text.MIMEBase)</dt> | |
| 103 <dd> | |
| 104 message to be prepared | |
| 105 </dd> | |
| 106 </dl><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 prepared message dictionary | |
| 110 </dd> | |
| 111 </dl><dl> | |
| 112 <dt>Return Type:</dt> | |
| 113 <dd> | |
| 114 dict | |
| 115 </dd> | |
| 116 </dl> | |
| 117 <div align="right"><a href="#top">Up</a></div> | |
| 118 <hr /><hr /> | |
| 119 <a NAME="_prepareMessage_v3" ID="_prepareMessage_v3"></a> | |
| 120 <h2>_prepareMessage_v3</h2> | |
| 121 <b>_prepareMessage_v3</b>(<i>message</i>) | |
| 122 <p> | |
| 123 Module function to prepare the message for sending (Python2 Variant). | |
| 124 </p><dl> | |
| 125 <dt><i>message</i> (email.mime.text.MIMEBase)</dt> | |
| 126 <dd> | |
| 127 message to be prepared | |
| 128 </dd> | |
| 129 </dl><dl> | |
| 130 <dt>Returns:</dt> | |
| 131 <dd> | |
| 132 prepared message dictionary | |
| 133 </dd> | |
| 134 </dl><dl> | |
| 135 <dt>Return Type:</dt> | |
| 136 <dd> | |
| 137 dict | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <div align="right"><a href="#top">Up</a></div> | |
| 141 <hr /><hr /> | |
| 142 <a NAME="getCredentials" ID="getCredentials"></a> | |
| 143 <h2>getCredentials</h2> | |
| 144 <b>getCredentials</b>(<i></i>) | |
| 145 <p> | |
| 146 Module function to get the Google credentials. | |
| 147 </p><dl> | |
| 148 <dt>Returns:</dt> | |
| 149 <dd> | |
| 150 Google Mail credentials | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /> | |
| 155 </body></html> |
