mail_queue_size

March 26, 2020

Name

mail_queue_size — Get the size of a mail queue

Synopsis

#include "mail_queue.h"

| int **mail_queue_size** ( | queue); |   |

mail_queue * <var class="pdparam">queue</var>;

Description

Returns the size of a mail queue, including active and delayed messages.

Parameters

queue

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

Return Values

This function returns the size of a mail queue: the total number of messages in the active and delayed queues.

Threading

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

See Also

mail_queue_active_queue_for_binding, mail_queue_delayed_size, and mail_queue_purge_domain_binding.