Created Notify_sparkpost (markdown)

Notify_sparkpost.md

@@ -0,0 +1,79 @@
+## SparkPost Notifications
+* **Source**: https://sparkpost.com/
+* **Icon Support**: No
+* **Attachment Support**: yes
+* **Message Format**: Text
+* **Message Limit**: 32768 Characters per message
+
+### Account Setup
+You can create an account for free [on their website](https://sparkpost.com/) but it comes with restrictions.
+
+For each domain you set up with them, you'll be able access them all from your dashboard once you're signed in. You'll need to generate an API key and grant it `transmission` access.
+
+### Syntax
+Valid syntaxes are as follows:
+* `sparkpost://{user}@{domain}/{apikey}/`
+* `sparkpost://{user}@{domain}/{apikey}/{email}/`
+* `sparkpost://{user}@{domain}/{apikey}/{email1}/{email2}/{emailN}/`
+
+You may also identify your region if you aren't using the US servers like so:
+* `sparkpost://{user}@{domain}/{apikey}/?region=eu`
+
+You can adjust what the Name associated with the From email is set to as well:
+* `sparkpost://{user}@{domain}/{apikey}/?From=Darth%20Vader`
+
+### Email Extensions
+If you wish to utilize extensions, you'll need to escape the addition/plus (+) character with **%2B** like so:<br/>
+`sparkpost://{user}@{domain}/{apikey}/chris%2Bextension@example.com`
+
+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
+| Variable    | Required | Description
+| ----------- | -------- | -----------
+| apikey      | Yes      | The API Key associated with the domain you want to send your email from. This is available to you after signing into their website an accessing the [dashboard](https://app.sparkpost.com/app/domains).
+| domain      | Yes      | The Domain you wish to send your email from; this domain must be registered and set up with your sparkpost account.
+| user        | Yes      | The user gets paired with the domain you specify on the URL to make up the **From** email address your recipients receive their email from.
+| batch       | No       | If batch mode is set to `yes` then all of email addresses are sent in a single batch for SparkPost to handle.
+| email       | No       | You can specify as many email addresses as you wish. Each address you identify here will represent the **To**.<br/>**Note:** Depending on your account setup, sparkpost does restrict you from emailing certain addresses.
+| region      | No       | Identifies which server region you intend to access. Supported options here are **eu** and **us**. By default this is set to **us** unless otherwise specified. This specifically affects which API server you will access to send your emails from.
+| from        | No       | This allows you to identify the name associated with the **From** email address when delivering your email.
+| to          | No       | This is an alias to the email variable. You can chain as many (To) emails as you want here separating each with a comma and/or space.
+| 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.
+
+#### Example
+Send a sparkpost notification to the email address bill.gates@microsoft.com
+```bash
+# Assuming the {domain} we set up with our sparkpost account is example.com
+# Assuming our {apikey} is  4b4f2918fddk5f8f91f
+# We already know our To {email} is bill.gates@microsoft.com
+# Assuming we want our email to come from noreply@example.com
+apprise sparkpost:///noreply@example.com/4b4f2918fddk5f8f91f/bill.gates@microsoft.com
+```
+
+### Header Manipulation
+Some users may require special HTTP headers to be present when they post their data to their server.  This can be accomplished by just sticking a hyphen (**-**) in front of any parameter you specify on your URL string.
+```bash
+# Below would set the header:
+#    X-Token: abcdefg
+#
+# Assuming the {domain} we set up with our sparkpost account is example.com
+# Assuming our {apikey} is  4b4f2918fddk5f8f91f
+# We already know our To {email} is bill.gates@microsoft.com
+# Assuming we want our email to come from noreply@example.com
+apprise -vv -t "Test Message Title" -b "Test Message Body" \
+   "sparkpost:///noreply@example.com/4b4f2918fddk5f8f91f/bill.gates@microsoft.com/?+X-Token=abcdefg"
+
+# Multiple headers just require more entries defined with a hyphen in front:
+# Below would set the headers:
+#    X-Token: abcdefg
+#    X-Apprise: is great
+#
+# Assuming the {domain} we set up with our sparkpost account is example.com
+# Assuming our {apikey} is  4b4f2918fddk5f8f91f
+# We already know our To {email} is bill.gates@microsoft.com
+# Assuming we want our email to come from noreply@example.com
+apprise -vv -t "Test Message Title" -b "Test Message Body" \
+   "sparkpost:///noreply@example.com/4b4f2918fddk5f8f91f/bill.gates@microsoft.com/?+X-Token=abcdefg&+X-Apprise=is%20great"
+```