SMTP2Go Notifications
Account Setup
Section titled “Account Setup”You can create an account for free on their website.
The next step is to simply generate an API Key associated with your account (on your Dashboard) here/
Syntax
Section titled “Syntax”Valid syntax is as follows:
smtp2go://{user}@{domain}/{apikey}/smtp2go://{user}@{domain}/{apikey}/{email}smtp2go://{user}@{domain}/{apikey}/{email1}/{email2}/{emailN}
You can adjust what the Name associated with the From email is set to as well:
smtp2go://{user}@{domain}/{apikey}/?from=Luke%20Skywalker
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| apikey | Yes | The API Key associated with your SMTP2Go account. You can acquire your API key from your dashboard here. |
| domain | Yes | The domain associated with the sending email 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. |
| No | You can specify as many email addresses as you wish. Each address you identify here will represent the To. | |
| 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 | Identify users you wish to send as a Carbon Copy |
| bcc | No | Identify users you wish to send as a Blind Carbon Copy |
Global Parameters
Section titled “Global Parameters”| Variable | Description |
|---|---|
| overflow | This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service.👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated.👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after. |
| format | This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored. |
| verify | External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes. |
| cto | This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds. |
| rto | This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds. |
| emojis | Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case. |
| tz | Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area. |
Examples
Section titled “Examples”Send a SMTP2Go notification to the email address bill.gates@microsoft.com
# Assuming the {domain} we set up with our SMTP2Go account is example.com# Assuming our {apikey} is api-60F0DD0AB5BA11ABA421F23C91C88EF4# We already know our To {email} is bill.gates@microsoft.com# Assuming we want our email to come from noreply@example.comapprise smtp2go:///noreply@example.com/api-60F0DD0AB5BA11ABA421F23C91C88EF4/bill.gates@microsoft.com