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

Updated Notify_email (markdown)

master
Chris Caron 2019-07-18 15:33:50 -04:00
parent 007bacbaac
commit 10c3d6d0d1
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Notify_email.md

@ -5,7 +5,7 @@
* **Message Limit**: 32768 Characters per message
## Using Built-In Email Services
If you are using one of the following Buil-In E-Mail services, then setting up this notification service has never been easier. If your provider isn't on the list and you'd like to request it, just [open up a ticket](https://github.com/caronc/nzb-notify/issues) and let me know. The alternative the the below list is to use a custom email server configuration; these are a little bit more complicated to set up, but still work great. Custom email configuration is discussed in the [next section](https://github.com/caronc/apprise/wiki/Notify_email/_edit#using-custom-servers-syntax).
If you are using one of the following Built-In E-Mail services, then setting up this notification service has never been easier. If your provider isn't on the list and you'd like to request it, just [open up a ticket](https://github.com/caronc/nzb-notify/issues) and let me know. The alternative the the below list is to use a custom email server configuration; these are a little bit more complicated to set up, but still work great. Custom email configuration is discussed in the [next section](https://github.com/caronc/apprise/wiki/Notify_email/_edit#using-custom-servers-syntax).
The following syntaxes work right out of the box:
* mailto://{userid}:{password}@**yahoo.com**
@ -27,16 +27,6 @@ If you're using your own SMTP Server or one that simply isn't in the *Built-In*
First off, secure vs insecure emails are defined by **mailto://** (port 25) and **mailtos://** (port 587) where **mailtos://** will enable TLS prior to sending the user and password.
If your SMTP server is identified by a different hostname than what is identified by the suffix of your email, then you'll need to specify it as an argument; for example:
* mailtos://userid:password@server.com?smtp=smtp.server.com
If you want to adjust the email's *ReplyTo* address, then you can do the following:
* mailtos://userid:password@server.com?smtp=smtp.server.com&from=noreply@server.com
You can also adjust the ReplyTo's Name too:
* mailtos://userid:password@server.com?smtp=smtp.server.com&from=noreply@server.com&name=Optional%20Name
Since URL's can't have spaces in them, you'll need to use '**%20**' as a place-holder for one (if needed). In the example above, the email would actually be received as *Optional Name*.
Here are some example syntaxes you can use when doing the custom approach:
* **mailto**://**{userid}**:**{password}**@**{domain}**
* **mailto**://**{userid}**:**{password}**@**{domain}**:**{port}**?smtp=**{smtp_server}**
@ -45,6 +35,18 @@ Here are some example syntaxes you can use when doing the custom approach:
Some mail servers will require your {userid} to be your full email address. In these cases, you'll need to specify your username in the url as an attribute like so:
* **mailto**://**{password}**@**{domain}**:**{port}**?user=**{userid}**
#### Custom Syntax Examples
If your SMTP server is identified by a different hostname than what is identified by the suffix of your email, then you'll need to specify it as an argument; for example:
* **mailtos**://**userid**:**password**@**server.com**?smtp=**smtp.server.com**
If you want to adjust the email's *ReplyTo* address, then you can do the following:
* **mailtos**://**userid**:**password**@**server.com**?smtp=**smtp.server.com**&from=**noreply@server.com**
You can also adjust the ReplyTo's Name too:
* **mailtos**://**userid**:**password**@**server.com**?smtp=**smtp.server.com**&from=**noreply@server.com**&name=**Optional%20Name**
Since URL's can't have spaces in them, you'll need to use '**%20**' as a place-holder for one (if needed). In the example above, the email would actually be received as *Optional Name*.
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------