Freeside:1.9:Documentation:Developer/FS/Misc

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 elimiate 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

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.

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).

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.

print ARRAYREF

Sends the lines in ARRAYREF to the printer.

BUGS

This package exists.

SEE ALSO

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