
This file describes the configuration of the asterisk fax receiver
in /etc/asterisk/faxreceive.conf.

Format
~~~~~~
The config file is formatted in ini-style. Each section corresponds
to a kindof "virtual fax machine". The sections are named
"recipient <recipient_name>", where <recipient_name> is the name
by which the respective section is referenced from Asterisk's
dialplan (see below for dialplan example). Please note that
the faxes for every recipient are counted in a file in
/var/lib/asterisk/faxreceive/counters/ - if you remove a recipient
from the config file, you might also want to remove the
corresponding counter file there.

Every option can be specified in every section specifically
for that respective recipient as well as globally before the first
recipient specific section (called the "global section" in
the following). If a value is specified in the specific section,
that is used, otherwise, if a value is specified in the global
section, that is used, and if no value is specified there either,
for many settings a sensible default is used.

Please note that a section must exist for every recipient to be
used, even if no specific options are specified.


Available Options
~~~~~~~~~~~~~~~~~
  email_from

    This specifies the email address that is used in the From: header
    of the mail containing the fax. It basically may be any RFC2822
    format address, including real names and such.


  email_to

    This specifies the email address the fax is to be sent to. Format
    as above at 'email_from'.


  paper_name
  paper_width
  paper_height

    The size of the page that incoming faxes are to be scaled to can
    be specified in different ways. Either you specify a paper format
    name which can be resolved into physical dimensions by libpaper
    (see papersize(5)) using the 'paper_name' option, or you specify
    the width and the height of the page in centimeters using the
    'paper_width' and 'paper_height' options, respectively.

    Note that any 'paper_width' and 'paper_height' settings override
    the values provided by 'paper_name'. If no paper size is specified,
    the default papersize of libpaper is used.


  margin_vertical
  margin_horizontal

    These options specify how much space at every vertical and horizontal
    edge of the specified page size is to be left blank when scaling,
    given in centimeters. The default is 0.25 cm for both.


  locale

    This option allows you to specify the locale that is used when
    generating the email containing the fax. Currently, only a German
    (de_DE) translation does exist.

    If you want to create a new translation, please note that
    currently only ISO-8859-1 locales are supported. That shouldn't
    be impossible to be changed, it just hasn't been done yet.


  temp_dir

    This specifies the directory below which the temporary directory
    for each reception is created, within which again any temporary
    files are placed. The default is the system's temporary directory,
    which is also used when an empty string is specified for this
    option.


Integrating asterisk_faxreceive with Asterisk
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is assumed that you have app_rxfax installed and working. Now, you
first have to add the following context to your dialplan:

   [faxrecv]
   exten => s,1,AGI(receive_fax,receive)
   exten => h,1,SetVar(MY_CALLERIDNUM=${CALLERIDNUM})
   exten => h,2,DeadAGI(receive_fax,deliver)

The name doesn't really matter, it's just jumped into from wherever you
instantiate a "virtual fax machine", which is done as follows:

   exten => 1234,1,SetVar(LOCALSTATIONID=+12-345-67890)
   exten => 1234,2,SetVar(FAXRECIPIENT=test)
   exten => 1234,3,Goto(faxrecv,s,1)

Here, you specify the extension that is to be answered (of course), plus
the local fax station ID that is transmitted to the sender, and the
"recipient"--that is the name selecting which section of the config
file applies for faxes received by this "fax machine".


$Id: README 77 2005-09-05 19:16:10Z florz $

