mail_queue_purge_domain_binding

March 26, 2020

Name

mail_queue_purge_domain_binding — Fail all messages for a binding/domain with a given status code

Synopsis

#include "mail_queue.h"

| int **mail_queue_purge_domain_binding** ( | dr, |   |
|   | binding_slot, |   |
|   | note, |   |
|   | quiet); |   |

domain_record * <var class="pdparam">dr</var>;
ec_binding_slot <var class="pdparam">binding_slot</var>;
char * <var class="pdparam">note</var>;
int <var class="pdparam">quiet</var>;

Description

Fail all messages for a binding/domain with a given delivery status notification (DSN).

Parameters

dr

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

binding_slot

The binding slot.

note

A string containing the DSN to use when purging the messages. If NULL, then the default string used is "554 5.4.4 [internal] Domain Lookup Failed".

quiet

An integer. Typically, EM_FAILED or EM_FAILED_QUIET.

Return Values

This function returns the number of messages failed for the binding/domain.

Threading

It is only legal to call this function in the Scheduler thread.

See Also

__get_global_mail_queue, mail_queue_active_queue_for_binding, mail_queue_delayed_size, and mail_queue_size.