Skip to content

Commit

Permalink
Update readme with deprecation warnings
Browse files Browse the repository at this point in the history
Add deprecation warning to popular XHR-based API calls.
  • Loading branch information
josteink authored Feb 1, 2019
1 parent 6d57ee9 commit 57fa77f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,8 @@ The data does not come from the DOM

#### gmail.get.email_data(thread_id=undefined)

**DEPRECATED! This function relies on XHR-invocation against a deprecated Gmail API and is is very likely to fail. Use `gmail.new.get.email_data()` and `gmail.new.get.thread_data()` instead!**

Returns an object representation of the opened email contents and metadata. It takes the optional thread_id parameter where
the data for the specified thread is returned instead of the email-thread currently visible in the dom.

Expand Down Expand Up @@ -428,6 +430,8 @@ Does the same as above but accepts a callback function

#### gmail.get.displayed_email_data()

**DEPRECATED! This function relies on XHR-invocation against a deprecated Gmail API and is is very likely to fail. Use `gmail.new.get.email_data()` and `gmail.new.get.thread_data()` instead!**

Returns an object representation of the emails that are being displayed.

```json
Expand Down

0 comments on commit 57fa77f

Please sign in to comment.