extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-12 09:51:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_email (markdown)

Chris Caron 2020-12-29 13:57:57 -05:00
parent b80c537250
commit d35606553b
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Notify_email.md

@ -6,7 +6,7 @@
* **Message Limit**: 32768 Characters per message
## Using Built-In Email Services
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).
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/apprise/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**
@ -37,6 +37,9 @@ Here are some example syntaxes you can use when doing the custom approach:
* **mailto**://**{userid}**:**{password}**@**{domain}**:**{port}**?smtp=**{smtp_server}**
* **mailto**://**{userid}**:**{password}**@**{domain}**:**{port}**?from=**{from_email}**&name=**{from_name}**
Using a local relay server that does not require authentication? No problem, use this:
* **mailto**://**{userid}**:**{password}**@**{domain}**:**{port}**?from=**{from_email}**&to=**{to_email}**
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}**
@ -50,6 +53,9 @@ If you want to adjust the email's *ReplyTo* address, then you can do the followi
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**
To send an email notification via a smtp server that does not require authentication, simply leave out the user and pass parameters in the URL:
* **mailto**://**server.com**?smtp=**smtp.server.com**&from=**noreply@server.com**&to=**myemail@server.com**
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*.
### Multiple To Addresses
@ -64,8 +70,8 @@ The Carbon Copy (**cc=**) and Blind Carbon Copy (**bcc=**) however are applied t
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| userid | Yes | The account login to your SMTP server; if this is an email you must specify this near the end of the URL as an argument. You can over-ride this by specifying `?user=` on the URL string.
| pass | Yes | The password required to send an email via your SMTP Server. You can over-ride this by specifying `?pass=` on the URL string.
| userid | Yes | The account login to your SMTP server; if this is an email you must specify this near the end of the URL as an argument. You can over-ride this by specifying `?user=` on the URL string.<br/>**Note:** Both the `userid` and `pass` are not required if you're using an anonymous login.
| pass | Yes | The password required to send an email via your SMTP Server. You can over-ride this by specifying `?pass=` on the URL string.<br/>**Note:** Both the `userid` and `pass` are not required if you're using an anonymous login.
| domain | Yes | If your email address was **test@example.com** then *example.com* is your domain. You must provide this as part of the URL string!
| port | No | The port your SMTP server is listening on. By default the port is **25** for **mailto://** and **587** for all **mailtos://** references.
| smtp | No | If the SMTP server differs from your specified domain, then you'll want to specify it as an argument in your URL.