pg_smtp_client

Overview

PIGSTY 3rd Party Extension: pg_smtp_client : PostgreSQL extension to send email using SMTP

Information

• Extension ID: 4170
• Extension Name: pg_smtp_client
• Package Name: pg_smtp_client
• Category: UTIL
• License: MIT
• Website: https://github.com/brianpursley/pg_smtp_client
• Language: Rust
• Extra Tags: pgrx
• Comment:

Metadata

• Latest Version: 0.2.0
• Postgres Support: 17,16,15,14
• Need Load: Shared library do not need explicit loading
• Need DDL: Need CREATE EXTENSION DDL
• Relocatable: Can be installed into other schemas
• Trusted: Trusted, Can be created by user with CREATE Privilege
• Schemas: smtp_client
• Requires: N/A

RPM / DEB

• RPM Repo: PIGSTY
• RPM Name: pg_smtp_client_$v
• RPM Ver : 0.2.0
• RPM Deps: N/A
• DEB Repo: PIGSTY
• DEB Name: postgresql-$v-pg-smtp-client
• DEB Ver : 0.2.0
• DEB Deps: N/A

Availability

Installation

Install pg_smtp_client via the pig CLI tool:

pig ext install pg_smtp_client

Install pg_smtp_client via Pigsty playbook:

./pgsql.yml -t pg_extension -e '{"pg_extensions": ["pg_smtp_client"]}' # -l <cls>

Install pg_smtp_client RPM from YUM repo directly:

dnf install pg_smtp_client_17;
dnf install pg_smtp_client_16;
dnf install pg_smtp_client_15;
dnf install pg_smtp_client_14;

Install pg_smtp_client DEB from APT repo directly:

apt install postgresql-17-pg-smtp-client;
apt install postgresql-16-pg-smtp-client;
apt install postgresql-15-pg-smtp-client;
apt install postgresql-14-pg-smtp-client;

Create pg_smtp_client extension on PostgreSQL cluster:

CREATE EXTENSION pg_smtp_client;

Usage

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

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']);