Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brianpursley/pg_smtp_client
PostgreSQL extension to send email using SMTP
https://github.com/brianpursley/pg_smtp_client
email postgres postgresql postgresql-extension rust smtp
Last synced: about 1 month ago
JSON representation
PostgreSQL extension to send email using SMTP
- Host: GitHub
- URL: https://github.com/brianpursley/pg_smtp_client
- Owner: brianpursley
- License: mit
- Created: 2024-06-06T18:54:50.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T14:37:29.000Z (2 months ago)
- Last Synced: 2024-10-30T15:36:42.125Z (2 months ago)
- Topics: email, postgres, postgresql, postgresql-extension, rust, smtp
- Language: Rust
- Homepage:
- Size: 51.8 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# pg_smtp_client
[](https://github.com/brianpursley/pg_smtp_client/actions/workflows/ci.yml)
A Postgres extension to send emails using SMTP.
## Installation
### Install using Trunk
```shell
trunk install pg_smtp_client
```
### Enabling the extension
Connect to postgres and run the following command.
```sql
CREATE EXTENSION IF NOT EXISTS pg_smtp_client CASCADE;
```
## Usage
Use the `smtp_client.send_email()` function to send an email.
### Function Parameters
| Parameter | Type | Description | System Configuration (Optional) |
| --- | --- | --- | --- |
| subject | text | The subject of the email | |
| body | text | The body of the email | |
| html | boolean | Whether the body is HTML (true) or plain text (false) | |
| from_address | text | The from email address | `smtp_client.from_address` |
| recipients | text[] | The email addresses of the recipients | |
| ccs | text[] | The email addresses to CCs | |
| bccs | text[] | The email addresses to BCCs | |
| smtp_server | text | The SMTP server to use | `smtp_client.server` |
| smtp_port | integer | The port of the SMTP server | `smtp_client.port` |
| smtp_tls | boolean | Whether to use TLS | `smtp_client.tls` |
| smtp_username | text | The username for the SMTP server | `smtp_client.username` |
| smtp_password | text | The password for the SMTP server | `smtp_client.password` |
### Default Configuration
You can configure the following system-wide default values for some of the parameters (as indiciated in the table above) like this:
```
ALTER SYSTEM SET smtp_client.server TO 'smtp.example.com';
ALTER SYSTEM SET smtp_client.port TO 587;
ALTER SYSTEM SET smtp_client.tls TO true;
ALTER SYSTEM SET smtp_client.username TO 'MySmtpUsername';
ALTER SYSTEM SET smtp_client.password TO 'MySmtpPassword';
ALTER SYSTEM SET smtp_client.from_address TO '[email protected]';
SELECT pg_reload_conf();
```
### Usage Examples
Send an email:
```sql
SELECT smtp_client.send_email('test subject', 'test body', false, '[email protected]', array['[email protected]'], null, null, 'smtp.example.com', 587, true, 'username', 'password');
```
Send an email using configured default values:
```sql
SELECT smtp_client.send_email('test subject', 'test body', false, null, array['[email protected]']);
```
Or, using named arguments:
```sql
SELECT smtp_client.send_email('test subject', 'test body', recipients => array['[email protected]']);
```