Difference between revisions of "Freeside:3:Documentation:Developer/FS/Misc"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
 
m (Edit via perl MediaWiki framework (1.13))
Line 58: Line 58:
 
; process_send_email OPTION => VALUE ...
 
; process_send_email OPTION => VALUE ...
 
:Takes arguments as per generate_email() and sends the message. This will die on any error and can be used in the job queue.
 
:Takes arguments as per generate_email() and sends the message. This will die on any error and can be used in the job queue.
 +
; process_send_generated_email OPTION => VALUE ...
 +
:Takes arguments as per send_email() and sends the message. This will die on any error and can be used in the job queue.
 
; send_fax OPTION => VALUE ...
 
; send_fax OPTION => VALUE ...
 
:Options:
 
:Options:
Line 84: Line 86:
 
; generate_pdf FILENAME
 
; generate_pdf FILENAME
 
:Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not contain the .tex suffix and is unlinked by this function.
 
:Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not contain the .tex suffix and is unlinked by this function.
−
; print ARRAYREF
+
; do_print ARRAYREF [, OPTION => VALUE ... ]
 
:Sends the lines in ARRAYREF to the printer.
 
:Sends the lines in ARRAYREF to the printer.
−
; csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
 
−
:Converts the filehandle referenced by FILEREF from fixed length record lines to a CSV file according to the lengths specified in LENGTH_LISTREF. The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each should return the value to be substituted in place of its single argument.
 
  
−
:Returns false on success or an error if one occurs.
+
:Options available are:
−
; ocr_image IMAGE_SCALAR
+
:; agentnum
−
:Runs OCR on the provided image data and returns a list of text lines.
+
::Uses this agent's 'lpr' configuration setting override instead of the global value.
 +
:; lpr
 +
::Uses this command instead of the configured lpr command (overrides both the global value and agentnum).
 +
:; csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
 +
::Converts the filehandle referenced by FILEREF from fixed length record lines to a CSV file according to the lengths specified in LENGTH_LISTREF. The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each should return the value to be substituted in place of its single argument.
 +
 
 +
::Returns false on success or an error if one occurs.
 +
:; ocr_image IMAGE_SCALAR
 +
::Runs OCR on the provided image data and returns a list of text lines.
  
 
==BUGS==
 
==BUGS==
Line 100: Line 108:
  
 
[[Freeside:3:Documentation:Developer/Fax/Hylafax/Client|Fax::Hylafax::Client]]
 
[[Freeside:3:Documentation:Developer/Fax/Hylafax/Client|Fax::Hylafax::Client]]
 +
 +
==POD ERRORS==
 +
Hey! '''The above document had some coding errors, which are explained below:'''
 +
 +
; Around line 963:
 +
:You forgot a '=back' before '=head1'

Revision as of 13:36, 27 June 2014

NAME

FS::Misc - Miscellaneous subroutines

SYNOPSIS

 use FS::Misc qw(send_email);

 send_email();

DESCRIPTION

Miscellaneous subroutines. This module contains miscellaneous subroutines called from multiple other modules. These are not OO or necessarily related, but are collected here to eliminate code duplication.

SUBROUTINES

send_email OPTION => VALUE ...
Options:
from
(required)
to
(required) comma-separated scalar or arrayref of recipients
subject
(required)
content-type
(optional) MIME type for the body
body
(required unless nobody is true) arrayref of body text lines
mimeparts
(optional, but required if nobody is true) arrayref of MIME::Entity->build PARAMHASH refs or MIME::Entity objects. These will be passed as arguments to MIME::Entity->attach().
nobody
(optional) when set true, send_email will ignore the body option and simply construct a message with the given mimeparts. In this case, content-type, if specified, overrides the default "multipart/mixed" for the outermost MIME container.
content-encoding
(optional) when using nobody, optional top-level MIME encoding which, if specified, overrides the default "7bit".
type
(optional) type parameter for multipart/related messages
custnum
(optional) FS::cust_main key; if passed, the message will be logged (if logging is enabled) with this custnum.
msgnum
(optional) FS::msg_template key, for logging.
generate_email OPTION => VALUE ...
Options:
from
Sender address, required
to
Recipient address, required
bcc
Blind copy address, optional
subject
email subject, required
html_body
Email body (HTML alternative). Arrayref of lines, or scalar.
Will be placed inside an HTML <BODY> tag.
text_body
Email body (Text alternative). Arrayref of lines, or scalar.
custnum, msgnum (optional)
Customer and template numbers, passed through to send_email for logging.
Constructs a multipart message from text_body and html_body.
process_send_email OPTION => VALUE ...
Takes arguments as per generate_email() and sends the message. This will die on any error and can be used in the job queue.
process_send_generated_email OPTION => VALUE ...
Takes arguments as per send_email() and sends the message. This will die on any error and can be used in the job queue.
send_fax OPTION => VALUE ...
Options:
dialstring - (required) 10-digit phone number w/ area code
docdata - (required) Array ref containing PostScript or TIFF Class F document
-or-
docfile - (required) Filename of PostScript TIFF Class F document
...any other options will be passed to Fax::Hylafax::Client::sendfax
states_hash COUNTRY
Returns a list of key/value pairs containing state (or other sub-country division) abbriviations and names.
counties STATE COUNTRY
Returns a list of counties for this state and country.
cities COUNTY STATE COUNTRY
Returns a list of cities for this county, state and country.
state_label STATE COUNTRY_OR_LOCALE_SUBCOUNRY_OBJECT; card_types
Returns a hash reference of the accepted credit card types. Keys are shorter identifiers and values are the longer strings used by the system (see Business::CreditCard).
pkg_freqs
Returns a hash reference of allowed package billing frequencies.
generate_ps FILENAME
Returns an postscript rendition of the LaTex file, as a scalar. FILENAME does not contain the .tex suffix and is unlinked by this function.
generate_pdf FILENAME
Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not contain the .tex suffix and is unlinked by this function.
do_print ARRAYREF [, OPTION => VALUE ... ]
Sends the lines in ARRAYREF to the printer.
Options available are:
agentnum
Uses this agent's 'lpr' configuration setting override instead of the global value.
lpr
Uses this command instead of the configured lpr command (overrides both the global value and agentnum).
csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
Converts the filehandle referenced by FILEREF from fixed length record lines to a CSV file according to the lengths specified in LENGTH_LISTREF. The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each should return the value to be substituted in place of its single argument.
Returns false on success or an error if one occurs.
ocr_image IMAGE_SCALAR
Runs OCR on the provided image data and returns a list of text lines.

BUGS

This package exists.

SEE ALSO

FS::UID, FS::CGI, FS::Record, the base documentation.

Fax::Hylafax::Client

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 963:
You forgot a '=back' before '=head1'
Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/Misc&oldid=7939"