QueueControl Objects¶

class control.QueueControl[source]¶

Postfix queue control using postsuper command.

The QueueControl instance defines the following attributes:

postsuper_cmd¶

Postfix command and arguments list() for mails queue administrative operations. Default is ["postsuper"]

known_operations¶

Known Postfix administrative operations dict to associate operations to command arguments. Known associations are:

 delete: -d
   hold: -h
release: -H
requeue: -r

Warning

Default known associations are provided for the default mails queue administrative command postsuper.

See also

Postfix manual:

postsuper – Postfix superintendent

The QueueControl instance provides the following methods:

QueueControl._operate(operation, messages)[source]¶

Generic method to lead operations messages from postfix mail queue.

Operations can be one of Postfix known operations stored in known_operations attribute. Operation argument is directly converted and passed to the postsuper_cmd command.

Parameters:	operation (str) – Known operation from known_operations. messages (list) – List of Mail objects targetted for operation.
Returns:	Command’s stderr output lines
Return type:	list()

QueueControl.delete_messages(messages)[source]¶

Delete several messages from postfix mail queue.

This method is a partial() wrapper on _operate(). Passed operation is delete

QueueControl.hold_messages(messages)[source]¶

Hold several messages from postfix mail queue.

This method is a partial() wrapper on _operate(). Passed operation is hold

QueueControl.release_messages(messages)[source]¶

Release several messages from postfix mail queue.

This method is a partial() wrapper on _operate(). Passed operation is release

QueueControl.requeue_messages(messages)[source]¶

Requeue several messages from postfix mail queue.

This method is a partial() wrapper on _operate(). Passed operation is requeue