Skip to content

Commit

Permalink
📧 Email Services Update
Browse files Browse the repository at this point in the history
[-] Removed `Gamil` Support (see issue #5)
[+] Updated `config` example
[+] Updated `README.md` & `gettingstarted.md`
  • Loading branch information
soranoo committed Aug 4, 2022
1 parent de559ed commit 229c937
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 17 deletions.
49 changes: 36 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,46 +9,69 @@ Providing the free webhook service to the basic plan users in TradingView.

### Portal ↠ [Installation](docs/gettingstarted.md#installing-python-package) · [Usage](docs/gettingstarted.md#setting-up-tradingview-alert)

## :newspaper: NEWS
:warning: **Gmail** is not longer SUPPORTED :warning:

**Google** has removed `Less secure apps` option. ([Reference Article](https://support.google.com/accounts/answer/6010255))
```
To help keep your account secure, from May 30, 2022,
​​Google no longer supports the use of third-party apps or
devices which ask you to sign in to your Google Account
using only your username and password.
Important: This deadline does not apply to Google Workspace or
Google Cloud Identity customers. The enforcement date for these
customers will be announced on the Workspace blog at a later date.
(BY Google)
```
(Special thanks: [`Pest202`](https://github.com/soranoo/TradingView-Free-Webhook-Alerts/issues/3))

For those who are seeking an alternative to Gmail: [LINK](https://github.com/soranoo/TradingView-Free-Webhook-Alerts/issues/5#issuecomment-1205433464)

:information_source: I will keep looking for other better IMAP services.
Please feel free to contact me if you have any suggestions.


## Features
* No Pro/Pro+/Premium TradingView account requested.

## How it works ?
Check the inbox frequently and transfer the TradingView alert email into the webhook message.


## Requirements
## :anchor: Requirements
* Python 3.6 or latest (*Developed in Python 3.8.1)
* An IMAP available email account (eg.Gmail, Hotmail, etc.)
* Gmail have be tested and works well
* An IMAP available email account (eg.Hotmail, Outlook, etc.)
* Hotmail have be tested and works well
* A TradingView account

## Getting Started
## :space_invader: Getting Started
To install **TradingView-Free-Webhook-Alerts**, check out the [Getting Started guide](docs/gettingstarted.md).


## Notice
## :mailbox_with_mail: Notice
* The program will read the incoming email and mark it as read.
* It is suggested to create a new email account for the best performance.
* If you are using Gmail as your email service provider, you should read through the following documents in order to protect your account from getting suspended; therefore, it is suggested to create a new Google account instead of using your main account.
* [Gmail receiving limits](https://support.google.com/a/answer/1366776)
* [Gmail bandwidth limits](https://support.google.com/a/answer/1071518)
* [Gmail server request limits](https://support.google.com/a/answer/1359240)
* The webhook message will not be sent immediately due to the latency of the email service provider. It will normally take about 2-5 seconds before the webhook message is sent.

## Combination
## :right_anger_bubble: Combination
You can combine the program with other services.
For example,
* You may use [TradingView-Webhook-Bot](https://github.com/fabston/TradingView-Webhook-Bot) to spread the webhook message.
* You may send the webhook to [3commas](https://3commas.io/) for auto trading.

## TODO
## :star: TODO
* Remove all potential risks that may be caused by the programme, for example, Gmail account was suspended because of high-frequency IMAP action (No reports show any Gmail account has been suspended due to this programme currently.).

## Known Issues
## :bug: Known Issues
* Inaccurate whole process time ([issue #3](https://github.com/soranoo/TradingView-Free-Webhook-Alerts/issues/3))
* [Rare] Sent duplicate alert ([issue #4](https://github.com/soranoo/TradingView-Free-Webhook-Alerts/issues/4))

## Disclaimer
## :robot: Useful Links
* Update TradingView `Email-To-SMS`: [LINK](https://www.tradingview.com/support/solutions/43000474398-how-to-change-the-email-to-sms-address-used-for-alert-notifications/)

## :bomb: Disclaimer
I as the author assume no responsibility for errors or omissions in the contents of the Service.

In no event shall I be liable for any special, direct, indirect, consequential, or incidental damages or any damages whatsoever, whether in an action of contract, negligence or other torts, arising out of or in connection with the use of the Service or the contents of the Service. I reserve the right to make additions, deletions, or modifications to the contents of the Service at any time without prior notice.
Expand Down
4 changes: 2 additions & 2 deletions config.example.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -----------* Email Service *-----------
email_address = "YourEmail@example.com"
email_address = "YourEmail@hotmail.com / YourEmail@outlook.com"
login_password = "YourPassword"
imap_server_address = "imap.gmail.com"
imap_server_address = "outlook.office365.com"
imap_server_port = 993

# --------------* Webhook *--------------
Expand Down
6 changes: 4 additions & 2 deletions docs/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You must finish the following steps before using the program.
2. Rename the copied file to `config.toml`.
3. Open `config.toml` with any text editor you like.
4. Fill in `email_address` and `login_password` with your email and password.
5. Fill in `imap_server` and `imap_port` with your email server and port. (For example, if you are using Gamil, it will be `imap.gmail.com` and `993`.)
5. Fill in `imap_server_address` and `imap_server_port` with your email server and port. (For example, if you are using Hotmail, it will be `outlook.office365.com` and `993`.)
6. Fill in `webhook_urls` with your webhook service URLs.
7. Save the config file.

Expand All @@ -35,8 +35,10 @@ You can adjust other settings on your own.

You must finish the following steps before using the program.

>:warning: **Gmail** is not longer SUPPORTED :warning:
1. Enable IMAP in your email account.
2. If you are using Gamil as your email service provider, you have to switch on the "[Less secure apps](https://myaccount.google.com/lesssecureapps)" option.
2. If you are using Microsoft(Hotmail/Outlook) as your email service provider, you have to switch say **YES** in `Let devices and apps use POP`([Setting ➜ Mail ➜ Sync email ➜ POP and IMAP](https://outlook.live.com/mail/0/options/mail/accounts/popImap)).

<a name="setting-up-tradingview-alert"></a>
## 4. Setting up TradingView alert
Expand Down

0 comments on commit 229c937

Please sign in to comment.