ec_log_transient_failure

March 26, 2020 Contributors

Name

ec_log_transient_failure — Record a transient delivery failure

Synopsis

#include "log.h"

| void **ec_log_transient_failure** ( | message, |   |
|   | domain, |   |
|   | now, |   |
|   | notestr); |   |

ec_message * <var class="pdparam">message</var>;
domain_record * <var class="pdparam">domain</var>;
struct timeval * <var class="pdparam">now</var>;
const string * <var class="pdparam">notestr</var>;

Description

Records the fact that Momentum was temporarily unable to delivery a message.

Parameters

message

A pointer to an ec_message struct. For documentation of this data structure see “ec_message”.

domain

A pointer to a domain_record struct. For documentation of this data structure see “domain_record”.

now

A pointer to a timeval struct, which may be NULL.

**Configuration Change. ** Prior to version 3.0, NULL was not an allowed value.

notestr

Typical use is to pass NULL to this parameter, in which case the string is pulled from the message construct. You may override this by passing string a DSN to use for logging the permanent failure.

Return Values

This function returns void.

Threading

It is legal to call this function in any thread.