Skip to main content

Name

log_attempt_v1 — Register a function with this hook whenever a message attempt event should be logged

Synopsis

#include "hooks/core/log_attempt_v1.h"

| void **core_log_attempt_v1** ( | closure, |   | |   | msg, |   | |   | dr, |   | |   | now, |   | |   | note, |   | |   | note_len); |   |

void * <var class="pdparam">closure</var>; ec_message * <var class="pdparam">msg</var>; domain_record * <var class="pdparam">dr</var>; struct timeval * <var class="pdparam">now</var>; const char * <var class="pdparam">note</var>; int <var class="pdparam">note_len</var>;

Description

Register a function with this hook whenever a message attempt event should be logged. This hook has a signature that closely mirrors the signature defined for the log_attempt callback in a logging_infrastructure_1 struct. For documentation of this data structure see “logging_infrastructure_1”.

Warning

Due to the vast number of attempts to deliver mail this hook should only be implemented for debugging purposes. All messages that are attempted will result in a transient failure, permanent failure or successful delivery - there is no need to log an attempt in a production system.

Parameters

closure

A pointer to the closure function.

msg

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

dr

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

now

A timeval struct.

note

?????

note_len

The length of the note string, in bytes.

Return Values

This hook returns void.

Threading

This hook will be called in any thread.

See Also

Was this page helpful?