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

feat(connector): postmark email connector #5886

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

srs
Copy link

@srs srs commented May 16, 2024

Summary

Implemented a Postmark email connector that uses Postmark API rather than SMTP. This provides the ability to use templates stored in Postmark instead of the templates stored in JSON.

This is implemented by looking at connector-sendgrid-email and implemented it as my understanding of best practices and convensions.

Testing

Have a simple uint-test that only checks configuration is valid (as also connector-sendgrid-email has). Else I did manual testing by connecting it in Logto UI and sending a test email trough the UI. Have also tested it in real-world scenarios by connecting it to an email provider.

Checklist

  • .changeset
  • unit tests
  • integration tests
  • necessary TSDoc comments

Copy link

COMPARE TO master

Total Size Diff ⚠️ 📈 +12.37 KB

Diff by File
Name Diff
packages/connectors/connector-postmark/CHANGELOG.md 📈 +84 Bytes
packages/connectors/connector-postmark/README.md 📈 +1.98 KB
packages/connectors/connector-postmark/logo.svg 📈 +3.63 KB
packages/connectors/connector-postmark/package.json 📈 +2.03 KB
packages/connectors/connector-postmark/src/constant.ts 📈 +1.34 KB
packages/connectors/connector-postmark/src/index.test.ts 📈 +345 Bytes
packages/connectors/connector-postmark/src/index.ts 📈 +1.67 KB
packages/connectors/connector-postmark/src/mock.ts 📈 +320 Bytes
packages/connectors/connector-postmark/src/types.ts 📈 +1002 Bytes

@srs
Copy link
Author

srs commented May 16, 2024

This solves #5885.

@simeng-li
Copy link
Contributor

@wangsijie @darcyYe can you guys take a look thx.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file will be auto generated.

Copy link
Contributor

@wangsijie wangsijie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good, could you add some basic test cases?

@wangsijie
Copy link
Contributor

Also, it would be nice if you can make the commits signed.

@srs
Copy link
Author

srs commented May 17, 2024

I will add some basic tests and do signed commits.

@charIeszhao
Copy link
Member

charIeszhao commented May 29, 2024

Hey just ask our designer to create a logo for you.

logo

@charIeszhao
Copy link
Member

The pnpm lockfile seems to be corrupted. Please try to resolve this issue in order to pass the CI checks.

Usually this can be resolved by running pnpm i

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

None yet

4 participants