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

Created Troubleshooting (markdown)

master
lead2gold 2019-01-27 15:50:24 -05:00
parent e8ddf28f44
commit abb360cd0d
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Troubleshooting.md Normal file

@ -0,0 +1,27 @@
## General Troubleshooting
The best thing you can do when troubleshooting problems with your notification is to use the _apprise_ object itself from the command line and add up the verbosity of the command (the more v's you specify, the more verbose it gets):
```bash
# In the below example, I am trying to figure out why my mailto:// line
# isn't working:
python apprise -vvv -t "test title" -b "test body" \
mailto://user:password@gmail.com
```
Sometimes the output is cryptic, but it can also help you pinpoint what is wrong with your URL.
Don't be afraid to ask here; open up a ticket and post your debug response. It might be just a simple tweak to your URL that is needed, otherwise we might have a good bug we need to solve.
Just be cautious as the debugging information can expose personal information (such as your password) to the screen. Please remember to erase this or swap it with some random characters before posting such a thing publicly.
## 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.