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 2022-11-02 11:12:51 -04:00
parent 37ac8e2bd7
commit 83b73ba20c
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
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/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).
If you are using one of the following Built-In E-Mail services, then setting up this notification service has never been easier. If the email provider you use 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 syntax works right out of the box:
* mailto://{user}:{password}@**yahoo.com**
@ -29,7 +29,7 @@ Secure connections are always implied whether you choose to use **mailto://** or
**Note** SendGrid users just need to be sure to use a Validated Domain (through their service) as part of the required **from=** email address (on the URL) or it will not work. It's additionally worth pointing out that [[sendgrid://|Notify_sendgrid]] has it's own separate integration as well if you do not need to use the SMTP service.
## Using Custom Servers Syntax
If you're using your own SMTP Server or one that simply isn't in the *Built-In* list defined in the previous section then things get a wee-bit more complicated.
If you're using a specific SMTP Server or one that simply isn't in the *Built-In* list defined in the previous section then things get a wee-bit more complicated.
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.
@ -76,9 +76,9 @@ The Carbon Copy (**cc=**) and Blind Carbon Copy (**bcc=**) however are applied t
| 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.
| from | No | If you want the email address *ReplyTo* address to be something other then your own email address, then you can specify it here.
| from | No | If you want the email address *Reply-To* address to be something other then your own email address, then you can specify it here.
| to | No | This will enforce (or set the address the email is sent To). This is only required in special circumstances. The notification script is usually clever enough to figure this out for you.
| name | No | With respect to {from_email}, this allows you to provide a name with your *ReplyTo* address.
| name | No | With respect to {from_email}, this allows you to provide a name with your *Reply-To* address.
| cc | No | Carbon Copy email address(es). More than one can be separated with a space and/or comma.
| bcc | No | Blind Carbon Copy email address(es). More than one can be separated with a space and/or comma.
| mode | No | This is only referenced if using **mailtos://** (a secure url). The Mode allows you to change the connection method. Some sites only support SSL (mode=**ssl**) while others only support STARTTLS (mode=**starttls**). The default value is **starttls**.