Hooks in the core scope

March 26, 2020 Contributors
Name Description
__mail_queue_maintain
aaa_log
annotate_batch Allow a module to assume responsibility for batch annotation
assess_batch Allow a module to assume responsibility for batch assessment
binding_group_choose_binding
body_modify
bounce_error_classify
cache_get
cache_set
check_outbound_conn_throttle
check_outbound_mess_throttle
config_get_domain_relay
config_fetch_domain_routes Override the routes setting
config_get_domain_host_failure_retry Determine whether there should be another delivery attempt
config_get_message_routing_domain Determine where to place a message
config_option_post_set
config_option_pre_set
connection_goal
connection_post_bind
control_allow_writable_config
control_allow_writable_config2
control_post_command
control_post_control
control_pre_command This hook point occurs prior to the execution of a console command
control_shutdown
control_shutdown_ex Invoked when shutdown occurs
dec_inbound_connections
dec_outbound_connections
disk_queue_core_inject
dns_get_As
dns_get_MXs
domain_requires_master_scheduler
ec_bag_find
ec_message_enqueue This hook is called whenever a message is passed to the ec_message_enqueue API
ec_message_mcmt_fixup
ec_message_mcmt_pre_fixup
ec_message_part_get_content_type
ec_message_set_next_attempt Allows modules to set the next attempt time of a message
ec_mime_component_extract_content_type
ec_ssl_SSL_CTX_fixup This hook provides an opportunity for modules to alter the context and add passphrase callbacks via OpenSSL functions
esmtp_message_sp_async_samfunc
final_validation This hook is invoked after the normal validation steps
gauge_cache_manip
generate_bounces
generate_rfc3464_message
generate_rfc3464_message_preamble
generate_soft_bounce_message
generate_soft_bounce_message_preamble
get_inbound_tls_parameters Allows implementors to override and control the usage of TLS on a per-message basis when accepting mail into the system
get_msg_expiration_params Allows modules to customize the expiration parameters on a per-message basis
get_outbound_tls_parameters Allows implementors to override and control the usage of TLS on a per-message basis when delivering mail out of the system
get_protocol_string_for_trace_headers
get_received_header_text Use this hook to set the text of the Received header in a message
inbound_smtp_tls_verify_callback
inc_inbound_connections
inc_outbound_conn_throttle
inc_outbound_connections
inc_outbound_mess_throttle
is_adaptive_scope_global
log_attempt_v1 Register a function with this hook whenever a message attempt event should be logged
log_client_connection_failure Register a function with this hook that will be invoked whenever an outbound connection attempt fails
log_client_connection_success Register a function with this hook that will be invoked whenever an outbound connection attempt succeeds
log_delivery_v1 Register a function with this hook whenever a delivery event should be logged.
log_error
log_permanent_failure_v1 Register a function with this hook whenever a permanent failure event should be logged.
log_reception_v1 Register a function with this hook whenever a reception event should be logged.
log_rejection Register a function with this hook that will be called whenever a logging event due to message rejection occurs
log_reopen This is invoked when "reopen logs" is issued though ec_console.
log_spool_import
log_transient_failure_v1 Register a function with this hook whenever a transient failure event should be logged.
mail_queue_get_next_active
mail_queue_insert_active
mail_queue_maintain_domain
mailq_get_next_active
mailq_insert_active
message_body_in_core
outbound_smtp_tls_verify_callback This hook allows you to augment the built-in TLS verification process for outbound SMTP sessions.
outbound_tls_ca
outbound_tls_cert
outbound_tls_ciphers
outbound_tls_key
outbound_tls_verify
post_assemble_fwd_message
post_config_commit
post_dns_handle_a
post_dns_handle_mx
post_drop_privileges
post_event_read
post_event_write
post_generate_rfc3464_message
post_generate_soft_bounce_message
post_initiate_connection_smtp
post_mail_queue_maintain_domain
post_read_smtp This hook is invoked immediately following data that has been read from the remote server during an outbound SMTP connection.
post_smtp_command
post_swap_in_meta Allows modules to perform actions immediately after the metadata file has been read from the spool. This hook is called even when the metadata fetch fails.
post_validate_data_spool_each_rcpt_v1
post_validate_set_binding
pre_console_release
pre_dns_handle_a
pre_dns_handle_mx
pre_drop_privileges
pre_ec_can_relay_to
pre_esmtp_auth
pre_event_close
pre_mail_queue_maintain_domain
pre_mail_queue_message_requeue
pre_mailq_message_requeue Invoked immediately prior to a message requeue action caused by a delivery failure.
pre_read_smtp
pre_swap_out_meta
premigrate_outbound_connection
rfc3464_inline_message_fragment
server_esmtp_session_abort
set_delayed_queue_event
smtp_client_mailfrom_args
smtp_client_rcptto_args
smtp_client_xclient_args
smtp_error_classify
smtp_should_session_shutdown Determine whether an SMTP session should be shut down
swap_out_multi Override or augment the internal call to swap_out_multi
sys_init
use_outbound_tls
validate_accept
validate_auth
validate_connect
validate_data_spool_each_rcpt This hook is invoked after the normal validate_data_spool_each_rcpt module callback.
validate_expand_string
veto_host_connection