Updated Notify_email (markdown)

master
Chris Caron 2022-12-09 18:01:22 -05:00
parent edb790ac29
commit c53366b086
1 changed files with 17 additions and 3 deletions

@ -28,6 +28,13 @@ 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.
## Email Addresses
When defining your email address you want to send to, you can format them in 2 ways:
- Classic: `just.an.email@domain.com`
- Name/Email: `John Doe <just.an.email@domain.com>`
Annotating your emails with names allow your delivered emails to have a nicer look/feel. You can also leverage these formats with the `from=` directive (defined below) allowing you to change who the email otherwise identifies who is sending it (providing your Mail Provider allows for it).
## Using Custom Servers Syntax
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.
@ -57,7 +64,10 @@ You can also adjust the ReplyTo's Name too:
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*.
Got a local passwordless SMTP relay service you're hosting? No problem, the following URL will work:
* `mailto://localhost`
Since URLs 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
By default your `mailto://` URL effectively works out to be `mailto://user:pass@domain` and therefore attempts to send your email to `user@domain` unless you've otherwise specified a `to=`. But you can actually send an email to more then one address using the same URL. Here are some examples (written slightly differently but accomplish the same thing) that send an email to more then one address:
@ -76,9 +86,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 *Reply-To* 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. You can express this as a regular `user@email.com` or you can also set it as `A User<user@email.com>`.
| 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 *Reply-To* address.
| name | No | With respect to {from_email}, this allows you to provide a name with your *Reply-To* address. <br/>**Note:** This field has become redundant and become synonymous to `from=`. It still behaves as it did in previous versions, but you can also follow the `A User<user@email.com>` syntax as well. To eliminate ambiguity; the values parsed from the `from=` will always trump the `name=`.
| 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**.
@ -118,4 +128,8 @@ apprise -vv -t "Test Message Title" -b "Test Message Body" \
# run in the background. So to make sure the URL sticks together
# and your terminal doesn't break your URL up, make sure to wrap
# it in quotes!
# Send an email to a smtp relay server your hosting on your box:
apprise -vv -t "Test Message Title" -b "Test Message Body" \
mailto://localhost
```