pg_smtp_client
pg_smtp_client
pg_smtp_client : PostgreSQL extension to send email using SMTP
Overview
| ID | Extension | Package | Version | Category | License | Language |
|---|---|---|---|---|---|---|
| 4170 | pg_smtp_client | pg_smtp_client | 0.2.1 | UTIL | MIT | Rust |
| Attribute | Has Binary | Has Library | Need Load | Has DDL | Relocatable | Trusted |
|---|---|---|---|---|---|---|
--s-dt- | No | Yes | No | Yes | no | yes |
| Relationships | |
|---|---|
| See Also | http pg_net pg_html5_email_address gzip bzip zstd pg_curl pgjq |
manual updated pgrx by Vonng
Packages
| Type | Repo | Version | PG Major Compatibility | Package Pattern | Dependencies |
|---|---|---|---|---|---|
| EXT | PIGSTY | 0.2.1 | 18 17 16 15 14 13 | pg_smtp_client | - |
| RPM | PIGSTY | 0.2.1 | 18 17 16 15 14 13 | pg_smtp_client_$v | - |
| DEB | PIGSTY | 0.2.1 | 18 17 16 15 14 13 | postgresql-$v-pg-smtp-client | - |
| Linux / PG | PG18 | PG17 | PG16 | PG15 | PG14 | PG13 |
|---|---|---|---|---|---|---|
el8.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
el8.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
el9.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
el9.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
el10.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
el10.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
d12.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
d12.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
d13.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
d13.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
u22.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
u22.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
u24.x86_64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
u24.aarch64 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | PIGSTY 0.2.1 | MISS |
Source
pig build pkg pg_smtp_client; # build rpm / deb with pigInstall
Make sure PGDG and PIGSTY repo available:
pig repo add pgdg pigsty -u # add both repo and update cacheInstall this extension with pig:
pig install pg_smtp_client; # install via package name, for the active PG version
pig install pg_smtp_client -v 18; # install for PG 18
pig install pg_smtp_client -v 17; # install for PG 17
pig install pg_smtp_client -v 16; # install for PG 16
pig install pg_smtp_client -v 15; # install for PG 15
pig install pg_smtp_client -v 14; # install for PG 14Create this extension with:
CREATE EXTENSION pg_smtp_client;Usage
Docs: https://github.com/frectonz/pglite-fusion/blob/main/README.md
Enabling the extension
Connect to postgres and run the following command.
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 'from@example.com';
SELECT pg_reload_conf();Usage Examples
Send an email:
SELECT smtp_client.send_email('test subject', 'test body', false, 'from@example.com', array['to@example.com'], null, null, 'smtp.example.com', 587, true, 'username', 'password');Send an email using configured default values:
SELECT smtp_client.send_email('test subject', 'test body', false, null, array['to@example.com']);Or, using named arguments:
SELECT smtp_client.send_email('test subject', 'test body', recipients => array['to@example.com']);Last updated on