Skip to main content

E-Mail Receipe

  • Official Website: n/a
  • Icon Support: no
  • Attachment Support: yes
  • Message Format: Text
  • 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 you can still 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.

The following receipes work right out of the box:

  • mailto://{userid}:{password}
  • mailto://{userid}:{password}
  • mailto://{userid}:{password}
  • mailto://{userid}:{password}
  • mailto://{userid}:{password}
  • mailto://{userid}:{app-password}
  • mailto://{userid}:{password}
  • mailto://{userid}:{password}
  • mailto://{userid}:{password}{validated_domain}

Secure connections are always implied whether you choose to use mailto:// or mailtos://

Note Google Users using the 2 Step Verification Process will be required to generate an app-password from here that you can use in the {password} field.

Note Fastmail Users are required to generate a custom App password before you can connect it up to send email to (from a 3rd party tool like this one). You must assign the SMTP option to the new App you generate. This Fastmail portion of this plugin currently supports [[the following 116 domains|Notify_email/Fastmail]]. Just make sure you identify the email address you're using when you build the mailto:// url and everything will work as intended.

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 Receipe#

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.

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.

Here are some example receipes you can use when doing the custom approach:

  • mailto://{userid}:{password}@{domain}
  • 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}

Custom Receipe 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://

If you want to adjust the email's ReplyTo address, then you can do the following:

You can also adjust the ReplyTo's Name too:

  • mailtos://

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:

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#

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:

  • mailto://user:pass@domain/?,
  • mailto://user:pass@domain/

There is no limit to the number of addresses you either separate by comma (,) and/or add to your mailto:// path separated by a slash (/).

The Carbon Copy (cc=) and Blind Carbon Copy (bcc=) however are applied to each email sent. Hence if you send an email to 3 target users, the entire cc and bcc lists will be part of all 3 emails.

Parameter Breakdown#

useridYesThe 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.
Note: Both the userid and pass are not required if you're using an anonymous login.
passYesThe password required to send an email via your SMTP Server. You can over-ride this by specifying ?pass= on the URL string.
Note: Both the userid and pass are not required if you're using an anonymous login.
domainYesIf your email address was then is your domain. You must provide this as part of the URL string!
portNoThe port your SMTP server is listening on. By default the port is 25 for mailto:// and 587 for all mailtos:// references.
smtpNoIf the SMTP server differs from your specified domain, then you'll want to specify it as an argument in your URL.
fromNoIf you want the email address ReplyTo address to be something other then your own email address, then you can specify it here.
toNoThis 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.
nameNoWith respect to {from_email}, this allows you to provide a name with your ReplyTo address.
ccNoCarbon Copy email address(es). More than one can be separated with a space and/or comma.
bccNoBlind Carbon Copy email address(es). More than one can be separated with a space and/or comma.
modeNoThis 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.

To eliminate any confusion, any url parameter (key=value) specified will over-ride what was detected in the url; hence:

  • mailto:// the userid of foobar would over-ride the userid usera specified. However since the password was not over-ridden, the password of pass123 would be used still.