github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

troubleshooting section at bottom moved to new troubleshooting wiki page

master
lead2gold 2019-01-29 14:37:15 -05:00
parent 5a3571fc1d
commit df90b5d335
1 changed files with 1 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Notify_email.md

@ -69,19 +69,4 @@ Send a email notification to our hotmail account:
# Built-In providers look after handling the little details such as
# the SMTP server, port, enforcing a secure connection, etc
apprise mailto:///example:mypassword@hotmail.com
```
### Special Characters and URL Conflicts
Apprise is built around URLs. Unfortunately URLs have pre-reserved characters it uses as delimiters that help distinguish one argument/setting from another.
For example, in a URL, the &, /, and % all have extremely different meanings and if they also reside in your password or user-name, they can cause quite a troubleshooting mess as to why your email isn't working.
Below is a chart of special characters and the value you should set them to; you ONLY need to do this if these values reside in your username and/or password; otherwise they will not cause a problem:
### Parameter Breakdown
| Character | Escape Code | Description
| ----------- | -------- | -----------
| **%** | **%25** | The percent sign itself is the magic character that tells anything parsing the URL to read the next few digits after it to determine what the character should actually be. The actual percent (%) character itself can be interpreted as _%25_ from within a URL.
| **&** | **%26** | The ampersand sign is how a URL knows to stop reading the current variable and move onto the next. If this existed within a password or username, it would only read 'up' to this character. You'll need to escape it if you make use of it.
| _(a space)_ | **%20** | While most URLs will work with the space, it's a good idea to escape it so that it can be clearly read from the URL.
| **/** | **%2F** | The slash is the most commonly used delimiter that exists in a URL and helps define a path and/or location.
```