generate_delay_dsn

March 26, 2020 Contributors

Name

generate_delay_dsn — Allows you to override a configured setting to generate a delay DSN for a given message

Synopsis

#include "hooks/delay_dsn/generate_delay_dsn.h"

| int **delay_dsn_generate_delay_dsn** ( | closure, |   |
|   | msg, |   |
|   | enabled); |   |

void * <var class="pdparam">closure</var>;
ec_message * <var class="pdparam">msg</var>;
int * <var class="pdparam">enabled</var>;

Description

The delay_dsn module allows delivery status notifications (DSNs) to be sent to the sender of a message, when that message has not yet been delivered. By default, no delay DSNs are sent.

This hook allows you to override a configured setting to generate a delay DSN for a given message.

Parameters

closure

A pointer to the closure.

msg

The ec_message. For a description of this data type see ec_message.

enabled

If *enabled equals 0, then generating a delay DSN is disabled. If *enabled equals 1, then generating a delay DSN is enabled.

Return Values

If GENERATE_DELAY_DSN_HOOK_CONT is returned, processing will fallback to other modules and then to the configuration. If GENERATE_DELAY_DSN_HOOK_OK is returned, then processing will terminate and the value passed back via enabled will be used.

Threading

This hook will be invoked in the Scheduler thread.

See Also

next_delay_dsn, send_notification, and the delay_dsn Module.