---
name: "Lire::OutputJob"
section: "3pm"
platform: "linux"
package: "lire"
version: "2.1.1-8"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Lire::OutputJob"
---

# Lire::OutputJob(3pm)

Object used to represent a configured formatting of a report

## NAME

Lire::OutputJob - Object used to represent a configured formatting of a report

## SYNOPSIS

```
  use Lire::OutputJob;
  use Lire::OutputFormat;
  my $email = new Lire::OutputJob( 'email', $output, $output_cfg,
                                   'emails' => [ 'email@domain.org' ] );
  $email->run( 'report.xml' );
  my $file = new Lire::OutputJob( 'file', $output, $output_cfg,
                                  'filename' => '/var/www/reports/daily-%Y%m%d'  );
  $file->run( 'report.xml' );
```

## DESCRIPTION

The Lire::OutputJob objects are used to represent how a report should formatted. These objects are most often created from the Lire configuration. (The 'output\_jobs' specification.)

## new( $destination\_type, $format, $format\_cfg, ... );

Create a new Lire::OutputJob object. Two parameters are required:

- $destination\_type

  Can be either 'email' or 'file'.

- $format

  A Lire::OutputFormat object.

- $format

  The configuration data that will be passed to the OutputFormat object.

The method will returns an instance of Lire::EmailOutputJob or Lire::FileOutputJob.

### format

Returns the Lire::OutputFormat associated with this OutputJob.

### format\_cfg

Returns the configuration data that will be used when formatting the report.

### run( $report\_file )

Formats and sends or save the XML report `$report_file` according the OutputJob parameters.

## Lire::EmailOutputJob

### Extra parameters for 'email' type

- emails

  An array reference to the emails that will receive the formatted report.

- subjet

  The subject of the email.

- extra\_file

  An additional text file that will be appended to text report or attach to other report types.

### emails()

Returns as an array the emails to which the report will be sent.

### subject()

Returns the subject of the email.

### extra\_file()

Returns the filename that will be appended to the text report or attach to the message for other report's type.

## Lire::FileOutputJob

### Extra parameters for 'file' type.

- file

  A file path with possible **strftime**(3pm) interpolation. This will be were the formatted report will be saved.

### file()

Returns this OutputJob destination file.

### output\_file( \[$time\] )

Returns the  destination file with [**strftime**(3)](/strftime/3.md) specifier interpolated.

## SEE ALSO

[**Lire::ReportJob**(3pm)](/Lire::ReportJob/3pm.md) [**Lire::OutputFormat**(3pm)](/Lire::OutputFormat/3pm.md)

## AUTHOR

```
  Francis J. Lacoste <flacoste@logreport.org>
```

## VERSION

`$Id:` OutputJob.pm,v 1.8 2006/07/23 13:16:29 vanbaal Exp $

## COPYRIGHT

Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.