Skip to content

Connections and OAuth

The lifecycle of a mailer connection — creation, updates, deletion, health checks, encrypted credentials — and the OAuth flows that keep API-mode connections authorized.

HookKindTierSinceSummary
boolean_smtp_aws_enable_imds_role_sourcefilterB1.0.0Filters whether BooleanSMTP probes the EC2 IMDSv2 endpoint for an IAM role.
boolean_smtp_before_connection_deleteactionA1.0.0Fires immediately before a connection is deleted.
boolean_smtp_connection_createdactionA1.0.0Fires after a connection has been created through the REST API.
boolean_smtp_connection_datafilterA1.0.0Filters a connection's data before it is created through the REST API.
boolean_smtp_connection_deletedactionA1.0.0Fires after a connection has been deleted.
boolean_smtp_connection_savedactionA1.0.0Fires after a connection has been written to the database, wherever the write came from.
boolean_smtp_connection_updatedactionA1.0.0Fires after a connection has been updated through the REST API.
boolean_smtp_google_oauth_redirect_urifilterA1.0.0Filters the redirect URI used for the Google OAuth2 connection flow.
boolean_smtp_health_checkaction (WP-Cron)B1.0.0Fires on the health-check interval; each run probes every active connection.
boolean_smtp_health_check_resultactionA1.0.0Fires after the scheduled health check has probed one connection and recorded the outcome on it.
boolean_smtp_microsoft_authorize_urlfilterB1.0.0Filters the Microsoft identity platform authorize URL used for delegated OAuth.
boolean_smtp_microsoft_oauth_redirect_urifilterA1.0.0Filters the redirect URI used for the Microsoft OAuth2 connection flow.
boolean_smtp_microsoft_token_urlfilterB1.0.0Filters the Microsoft identity platform token endpoint used to exchange or refresh delegated and application tokens.
boolean_smtp_oauth_providers_registeractionA1.0.0Fires after the built-in OAuth providers have been registered.
boolean_smtp_oauth_refreshaction (WP-Cron)B1.0.0Fires on the OAuth refresh interval; each run renews the access tokens that are about to expire.
boolean_smtp_oauth_refresh_failedactionA1.0.0Fires after an OAuth token refresh fails, once retries are exhausted.
boolean_smtp_oauth_refresh_successactionA1.0.0Fires after an OAuth token refresh succeeds.
boolean_smtp_sensitive_keysfilterA1.0.0Filters the exact settings-key names whose values are encrypted at rest, masked in REST responses and redacted from logs.
boolean_smtp_ses_iam_credentialsfilterB1.0.0Filters the predefined IAM credentials available for SES connections to select from.
boolean_smtp_ses_iam_selectorfilterB1.0.0Filters the list of predefined IAM credentials offered in the SES connection form.
boolean_smtp_zoho_oauth_redirect_urifilterA1.0.0Filters the redirect URI used for the Zoho OAuth2 connection flow.