Skip to content

Commit 8ac7f77

Browse files
rickypcrickypc
committed
Minor enhancements.
- Add subject and text filters - Add non-secure connection support - Adjust documentation - Add more unit test - Add backward compatible support - Add `Delete All Emails`, `Delete Email`, `Mark All Emails As Read`, and `Mark Email As Read` keywords. - Add alternative keyword to deprecated keywords.
1 parent 4b39694 commit 8ac7f77

File tree

6 files changed

+541
-196
lines changed

6 files changed

+541
-196
lines changed

‎CHANGELOG.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
0.2.1 (2015.12.20)
2+
==================
3+
4+
* Add subject and text filters
5+
* Add non-secure connection support
6+
* Adjust documentation
7+
* Add more unit test
8+
* Add backward compatible support
9+
* Add `Delete All Emails`, `Delete Email`, `Mark All Emails As Read`, and `Mark Email As Read` keywords
10+
* Add alternative keyword to deprecated keywords
11+
112
0.2.0 (2015.12.15)
213
==================
314

‎README.rst

Lines changed: 39 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,11 @@ ImapLibrary is a IMAP email testing library for `Robot Framework`_.
1010

1111
More information about this library can be found in the `Keyword Documentation`_.
1212

13-
Non-Backward Compatible Warning
14-
-------------------------------
15-
16-
There are inevitable changes to parameter names that would not be backward compatible with
17-
release 0.1.4 downwards.
18-
These changes are made to comply with Python code style guide on `Method Names and Instance Variables`_.
19-
2013
Authoritative Repository
2114
------------------------
2215

23-
This repository is the new authoritative repository for robotframework-imaplibrary package,
24-
and I am also the new project maintainer for robotframework-imaplibrary project.
16+
This repository is the new authoritative repository for `robotframework-imaplibrary`_ package,
17+
and I am also the new project maintainer for `robotframework-imaplibrary`_ project.
2518

2619
I will go through the pull requests from old repository, as well as issue list.
2720
I will try to accomodate as much as I could as time permit. **There is no need to re-post.**
@@ -31,46 +24,46 @@ If you are interested to contribute back to this project, please see **Contribut
3124
Example
3225
'''''''
3326

34-
+----------------+----------------------------+-------------------------------+-----------------+
35-
| Open Mailbox | server=imap.googlemail.com | user=email@gmail.com | password=secret |
36-
+----------------+----------------------------+-------------------------------+-----------------+
37-
| ${LATEST} = | Wait For Mail | from_email[email protected] | timeout=300 |
38-
+----------------+----------------------------+-------------------------------+-----------------+
39-
| ${HTML} = | Open Link From Mail | ${LATEST} |
40-
+----------------+----------------------------+-------------------------------------------------+
41-
| Should Contain | ${HTML} | Your email address has been updated |
42-
+----------------+----------------------------+-------------------------------------------------+
43-
| Close Mailbox |
44-
+-----------------------------------------------------------------------------------------------+
27+
+----------------+----------------------+---------------------------+-----------------+
28+
| Open Mailbox | host=imap.domain.com | user=email@domain.com | password=secret |
29+
+----------------+----------------------+---------------------------+-----------------+
30+
| ${LATEST} = | Wait For Email | sender[email protected] | timeout=300 |
31+
+----------------+----------------------+---------------------------+-----------------+
32+
| ${HTML} = | Open Link From Email | ${LATEST} |
33+
+----------------+----------------------+---------------------------------------------+
34+
| Should Contain | ${HTML} | Your email address has been updated |
35+
+----------------+----------------------+---------------------------------------------+
36+
| Close Mailbox |
37+
+-------------------------------------------------------------------------------------+
4538

4639
Multipart Email Example
4740
'''''''''''''''''''''''
4841

49-
+----------------+----------------------------+-------------------------------+-----------------+
50-
| Open Mailbox | server=imap.googlemail.com | user=email@gmail.com | password=secret |
51-
+----------------+----------------------------+-------------------------------+-----------------+
52-
| ${LATEST} = | Wait For Mail | from_email[email protected] | timeout=300 |
53-
+----------------+----------------------------+-------------------------------+-----------------+
54-
| ${parts} = | Walk Multipart Email | ${LATEST} |
55-
+----------------+----------------------------+-------------------------------+-----------------+
56-
| :FOR | ${i} | IN RANGE | ${parts} |
57-
+----------------+----------------------------+-------------------------------+-----------------+
58-
| \\ | Walk Multipart Email | ${LATEST} |
59-
+----------------+----------------------------+-------------------------------------------------+
60-
| \\ | ${content-type} = | Get Multipart Content Type |
61-
+----------------+----------------------------+-------------------------------------------------+
62-
| \\ | Continue For Loop If | '${content-type}' != 'text/html' |
63-
+----------------+----------------------------+-------------------------------+-----------------+
64-
| \\ | ${payload} = | Get Multipart Payload | decode=True |
65-
+----------------+----------------------------+-------------------------------+-----------------+
66-
| \\ | Should Contain | ${payload} | your email |
67-
+----------------+----------------------------+-------------------------------+-----------------+
68-
| \\ | ${HTML} = | Open Link From Mail | ${LATEST} |
69-
+----------------+----------------------------+-------------------------------+-----------------+
70-
| \\ | Should Contain | ${HTML} | Your email |
71-
+----------------+----------------------------+-------------------------------+-----------------+
72-
| Close Mailbox |
73-
+-----------------------------------------------------------------------------------------------+
42+
+----------------+----------------------+---------------------------+-----------------+
43+
| Open Mailbox | host=imap.domain.com | user=email@domain.com | password=secret |
44+
+----------------+----------------------+---------------------------+-----------------+
45+
| ${LATEST} = | Wait For Email | sender[email protected] | timeout=300 |
46+
+----------------+----------------------+---------------------------+-----------------+
47+
| ${parts} = | Walk Multipart Email | ${LATEST} |
48+
+----------------+----------------------+---------------------------+-----------------+
49+
| :FOR | ${i} | IN RANGE | ${parts} |
50+
+----------------+----------------------+---------------------------+-----------------+
51+
| \\ | Walk Multipart Email | ${LATEST} |
52+
+----------------+----------------------+---------------------------------------------+
53+
| \\ | ${content-type} = | Get Multipart Content Type |
54+
+----------------+----------------------+---------------------------------------------+
55+
| \\ | Continue For Loop If | '${content-type}' != 'text/html' |
56+
+----------------+----------------------+---------------------------+-----------------+
57+
| \\ | ${payload} = | Get Multipart Payload | decode=True |
58+
+----------------+----------------------+---------------------------+-----------------+
59+
| \\ | Should Contain | ${payload} | your email |
60+
+----------------+----------------------+---------------------------+-----------------+
61+
| \\ | ${HTML} = | Open Link From Email | ${LATEST} |
62+
+----------------+----------------------+---------------------------+-----------------+
63+
| \\ | Should Contain | ${HTML} | Your email |
64+
+----------------+----------------------+---------------------------+-----------------+
65+
| Close Mailbox |
66+
+-------------------------------------------------------------------------------------+
7467

7568
Installation
7669
------------
@@ -233,12 +226,12 @@ Documentation and other similar content are provided under `Creative Commons Att
233226
.. _Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License: http://goo.gl/SNw73V
234227
.. _Imap Library CLA: https://goo.gl/forms/QMyqXJI2LM
235228
.. _Keyword Documentation: https://goo.gl/ntRuxC
236-
.. _Method Names and Instance Variables: https://goo.gl/NxxD0n
237229
.. _pip: http://goo.gl/jlJCPE
238230
.. _Robot Framework: http://goo.gl/lES6WM
239231
.. _Robot Framework Documentation: http://goo.gl/zy53tf
240232
.. _Robot Framework installed: https://goo.gl/PFbWqM
241233
.. _Robot Framework User Guide: http://goo.gl/Q7dfPB
234+
.. _robotframework-imaplibrary: https://goo.gl/q66LcA
242235
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
243236
:target: https://goo.gl/ntRuxC
244237
:alt: Keyword Documentation

‎doc/ImapLibrary.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)