Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added SMTP2Go (with Attachment) Support #389

Merged
merged 3 commits into from
May 16, 2021
Merged

Added SMTP2Go (with Attachment) Support #389

merged 3 commits into from
May 16, 2021

Conversation

caronc
Copy link
Owner

@caronc caronc commented May 15, 2021

Description:

Related issue (if applicable): #379

Added SMTP2Go support supporting bcc, cc, and file attachments. 👍

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

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

Variable Required Description
apikey Yes The API Key associated with the domain you want to send your email from. 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.
email 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

Example

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.com
apprise smtp2go:///noreply@example.com/api-60F0DD0AB5BA11ABA421F23C91C88EF4/bill.gates@microsoft.com

New Service Completion Status

  • apprise/plugins/NotifySMTP2Go.py
  • setup.py
    • add new service into the keywords section of the setup() declaration
  • README.md
    • add entry for new service to table (as a quick reference)
  • packaging/redhat/python-apprise.spec
    • add new service into the %global common_description

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • No lint errors (use flake8)
  • 100% test coverage

@codecov-commenter
Copy link

codecov-commenter commented May 15, 2021

Codecov Report

Merging #389 (d88b18d) into master (59aa5f5) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##            master      #389    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           93        94     +1     
  Lines        11768     11950   +182     
  Branches      1965      2005    +40     
==========================================
+ Hits         11768     11950   +182     
Impacted Files Coverage Δ
apprise/plugins/NotifySMTP2Go.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 59aa5f5...d88b18d. Read the comment docs.

@caronc caronc merged commit 51f9197 into master May 16, 2021
@caronc caronc deleted the 379-smtp2go-support branch September 18, 2021 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants