---
name: "Postfix::Parse::Mailq"
section: "3pm"
platform: "linux"
package: "libpostfix-parse-mailq-perl"
version: "1.005-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Postfix::Parse::Mailq"
---

# Postfix::Parse::Mailq(3pm)

parse the output of the postfix mailq command

## NAME

Postfix::Parse::Mailq - parse the output of the postfix mailq command

## VERSION

version 1.005

## SYNOPSIS

```
  use Postfix::Parse::Mailq;
  my $mailq_output = `mailq`;
  my $entries = Postfix::Parse::Mailq->read_string($mailq_output);
  my $bytes = 0;
  for my $entry (@$entries) {
    next unless grep { /\@aol.com$/ } @{ $entry->{remaining_rcpts} };
    $bytes += $entry->{size};
  }

  print "$bytes bytes remain to send to AOL destinations\n";
```

## METHODS

### read\_file

### read\_handle

### read\_string

```
  my $entries = Postfix::Parse::Mailq->read_string($string, \%arg);
```

This methods read the output of postfix's *mailq* from a file (by name), a filehandle, or a string, respectively.  They return an arrayref of hashrefs, each hashref representing one entry in the queue as reported by *mailq*.

Valid arguments are:

```
  spool - a hashref of { queue_id -> spool_name } pairs
          if given, this will be used to attempt to indicate in which
          spool messages currently are; it is not entirely reliable (race!)
```

### parse\_block

```
  my $entry = Mailq->parse_block(\@lines);
```

Given all the lines in a single entry's block of lines in mailq output, this returns data about the entry.

## WARNING

This code is really rough and the interface will change.  Entries will be objects.  There will be some more methods.  Still, the basics are likely to keep working, or keep pretty close to what you see here now.

## AUTHOR

Ricardo SIGNES \<rjbs@cpan.org\>

## CONTRIBUTOR

Johan Carlquist \<jocar@su.se\>

## COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.