Table Of Contents
fax send coverpage e-mail-controllable
fax send coverpage show-detail
fax send transmitting-subscriber
Command Reference
This section documents new or modified commands A though L. All other commands beginning with the letter A through L used with this feature are documented in the Cisco IOS Release 12.0 command references.
•
destination-pattern
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
destination-pattern
To specify either the prefix or the full E.164 telephone number (depending on your dial plan) to be used for a POTS or MMoIP dial peer, use the destination-pattern dial-peer configuration command. Use the no form of this command to restore the default value.
destination-pattern [+]string
no destination-patternSyntax Description
Defaults
Enabled with a null string.
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the destination-pattern command to define the E.164 telephone number for this dial peer.
This pattern is used to match dialed digits to a dial peer. The dial peer is then used to complete the call. When a router receives voice data, it compares the called number (the full E.164 telephone number) in the packet header with the number configured as the destination pattern for the voice-telephony peer. The router then strips out the left-justified numbers corresponding to the destination pattern. If you have configured a prefix, the prefix will be appended to the front of the remaining numbers, creating a dial string, which the router will then dial. If all numbers in the destination pattern are stripped-out, the user will receive a dial tone.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Note
Examples
The following example configures the E.164 telephone number "555-1234" for a dial peer:
dial-peer voice 10 potsdestination-pattern +5551234dial-peer voice
To enter dial-peer configuration mode, define the type of dial peer, and define the tag number associated with this dial peer, use the dial-peer voice global configuration command. Use the no form of this command to disable this dial peer.
dial-peer voice number {pots | mmoip | voip}
no dial-peer voice numberSyntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the dial-peer voice global configuration command to switch to dial-peer configuration mode from global configuration mode and to define a particular dial peer. Use the exit command to exit dial-peer configuration mode and return to global configuration mode.
In Store and Forward Fax on the Cisco AS5300, the POTS dial peer defines the inbound faxing line characteristics from the sending fax device to the receiving Cisco AS5300 and the outbound line characteristics from the sending Cisco AS5300 to the receiving fax device. The MMoIP dial peer defines the inbound faxing line characteristics from the Cisco AS5300 to the receiving SMTP mail server.
After you have created a dial peer, that dial peer remains defined and active until you disable that particular dial peer. To disable a dial peer, use the no form of this command.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Note
Example
The following example accesses dial-peer configuration mode and configures a POTS peer identified as dial peer 10 and an MMoIP dial peer identified as dial peer 20:
configure terminaldial-peer voice 10 potsdial-peer voice 20 mmoipThe following example disables the MMoIP peer identified as dial peer 20:
configure terminalno dial-peer voice 20direct-inward-dial
To enable the Direct Inward Dial (DID) call treatment for the incoming called number, use the direct-inward-dial dial-peer configuration command. Use the no form of this command to disable DID.
direct-inward-dial
no direct-inward-dialSyntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Dial-peer configuration
Command History
11.3(1)NA
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the direct-inward-dial command to enable the DID call treatment for the incoming called numbers. When this feature is enabled, the incoming call is treated as if the digits are received from the DID trunk. The called number is used to select the outgoing dial peer. No dial tone will be presented to the caller.
Use the no form of this command to disable DID. When disabled, the called number is used to select the outgoing dial peer. The caller will be prompted for a called number via dial tone.
This command is only applicable to POTS dial peers. This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example enables DID call treatment for incoming called numbers:
dial peer voice 10 potsdirect-inward-dialdsn
To specify that a delivery status notice be delivered to the sender, use the dsn MMoIP dial-peer configuration command. Use the no form of this command to cancel a specific delay status notice option.
dsn {delay | failure | success}
no dsn {delay | failure | success}Syntax Description
Note
Defaults
The default is success and failure.
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Delivery status notifications (DSNs) are messages or responses that are automatically generated and sent to the sender or originator of an e-mail message by the SMTP server, notifying the sender of the status of the e-mail message. Specifications for DSN are described in RFC 1891, RFC 1892, RFC 1893, and RFC 1894.
The on-ramp DSN request is included as part of the fax-mail message sent by the on-ramp gateway when the matching MMoIP dial peer has been configured. The on-ramp DSN response is generated by the SMTP server when the fax-mail message is accepted. The DSN is sent back to the user defined in using the mta send mail-from command. The off-ramp DSN is requested by the e-mail client. The DSN response is generated by the SMTP server when it receives a request as part of the fax-mail message.
Note
Because the SMTP server generates the DSNs, you need to configure both the mail from: and rcpt to: commands for the DSN feature to be operational. For example:
mail from: <user@mail-server.company.com>rcpt to: <fax=555-1212@company.com> NOTIFY=SUCCESS,FAILURE,DELAYThere are three different states that can be reported back to the sender:
•
•
•
Because these delivery states are not mutually exclusive, you can configure Store and Forward Fax to generate these messages for all or any combination of these events.
DSN messages notify the sender of the status of a particular e-mail message containing a fax TIFF image. Use the dsn command to specify which notification messages will be sent to the user.
The dsn command allows you to select more than one notification option by reissuing the command, specifying a different notification option each time. To discontinue a specific notification option, use the no form of the command for that specific keyword.
Note
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example specifies that a DSN message be returned to the sender when the e-mail message containing the fax has been successfully delivered to the recipient or if the message containing the fax has failed, for whatever reason, to be delivered:
dial-peer voice 10 mmoipdsn successdsn failureThe following example specifies that a DSN message be returned to the sender either when the e-mail message containing the fax has been successfully delivered to the recipient or when the message has been delayed:
dial-peer voice 10 mmoipdsn successdsn delayedRelated Commands
fax receive called-subscriber
To define the called subscriber identifier (CSI), use the fax receive called-subscriber global configuration command. Use the no form of this command to disable the configured number.
fax receive called-subscriber {$d$ | string}
no fax receive called-subscriber {$d$ | string}Syntax Description
Defaults
Enabled with a null string.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the fax receive called-subscriber command to define the number displayed in the LCD of the sending fax device when you are sending a fax to a recipient. Typically, with a standard Group 3 fax device, this is the telephone number associated with the receiving fax device. The command defines the CSI.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures the number "555-1234" as the called-subscriber number:
configure terminalfax receive called-subscriber 5551234fax send center-header
To specify the data that will appear in the center position of the fax header information, use the fax send center-header global configuration command. Use the no form of this command to disable the selected options.
fax send center-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
no fax send center-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}Syntax Descriptions
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the Cisco AS5300's text-to-fax converter. When this conversion is performed, this fax send center-header command is used to indicate what header information should be added to the center top those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers, and the Cisco AS5300's software does not modify TIFF attachments.
Note
This command lets you configure multiple options at once—meaning that you can combine one or more wild cards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the transmission time of the fax as the center fax header information:
configure terminalfax send center-header $t$The following example configures the company name "Widget" and its address as the center fax header information:
configure terminalfax send center-header widget $s$Related Commands
fax send left-header
Specifies the data that will appear on the left in the fax header.
fax send right-header
Specifies the data that will appear on the right in the fax header.
fax send coverpage comment
To define personalized text for the title field of a fax cover sheet, use the fax send coverpage comment global configuration command. Use the no form of this command to disable the defined comment.
fax send coverpage comment string
no fax send coverpage comment stringSyntax Description
string
Text string that adds personalized text in the title field of the fax cover sheet. Valid characters are any ASCII characters.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
The fax send coverpage comment command can be overridden by the fax send coverpage e-mail controllable command.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures an individualized title comment of "Acme Fax Services" for generated fax cover sheets:
configure terminalfax send coverpage enablefax send coverpage comment Acme Fax ServicesRelated Commands
fax send coverpage e-mail-controllable
To defer to the cover page setting in the e-mail header to generate a standard fax cover sheet, use the fax send coverpage e-mail-controllable global configuration command. Use the no form of this command to disable standard fax sheet generation.
fax send coverpage e-mail-controllable
no fax send coverpage e-mail-controllableSyntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
You can also use the destination address of an e-mail message to control the cover page generation on a per-recipient basis. Use the fax send coverpage e-mail-controllable command to configure the router to defer to the cover page setting in the e-mail header.
In essence, the off-ramp router defers to the setting configured in the e-mail address itself. For example, if the address has a parameter set to cover=no, this parameter will override the setting for the fax send coverpage enable command and the off-ramp gateway will not generate and send a fax cover page. If the address has a parameter set to cover=yes, the off-ramp gateway will defer to this and generate and send a fax cover page.
shows examples of what the user would enter in the To: field of the e-mail message.
Table 3
Example Entries for the To: Field
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example enables standard generated fax cover sheets:
configure terminalfax send coverpage enablefax send coverpage e-mail-controllableRelated Commands
fax send coverpage enable
To enable the Cisco AS5300 to generate fax cover sheets for faxes that originate from e-mail messages, use the fax send coverpage enable global configuration command. Use the no form of this command to disable fax cover sheet generation functionality.
fax send coverpage enable
no fax send coverpage enableSyntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Note
This command applies to off-ramp Store and Forward Fax functions.
Example
The following example enables Cisco AS5300-generated fax cover sheets:
configure terminalfax send coverpage enableRelated Commands
fax send coverpage show-detail
To print all of the e-mail header information as part of the fax cover sheet, use the fax send coverpage show-detail global configuration command. Use the no form of this command to disable the e-mail header information being displayed.
fax send coverpage show-detail
no fax send coverpage show-detailSyntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Note
Examples
The following example configures an individualized generated fax cover sheet that contains the e-mail header text:
configure terminalfax send coverpage enableno fax send coverpage e-mail-controllablefax send coverpage show-detailRelated Commands
fax send left-header
To specify the data that will appear on the left in the fax header, use the fax send left-header global configuration command. Use the no form of this command to disable the selected options.
fax send left-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
no fax send left-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the AS5300's text-to-fax converter. When this conversion is performed, this fax send left-header command is used to indicate what header information should be added to the left top of those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers and the AS5300's software does not modify TIFF attachments.
This command lets you configure multiple options at once—meaning that you can combine one or more wild cards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Example
The following example selects the transmission time of the fax as the left fax header information:
configure terminalfax send left-header $t$The following example configures the company name "Widget" and its address as the left fax header information:
configure terminalfax send left-header widget $s$Related Commands
fax send max-speed
To specify the maximum speed at which an outbound fax will be transmitted, use the fax send max-speed global configuration command. Use the no form of this command to disable the selected speed.
fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 9600}
no fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 9600}Syntax Description
Defaults
14400
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example sets the outbound fax transmission rate at 2400 bps:
configure terminalfax send max-speed 2400fax send right-header
To specify the data that will appear on the right in the fax header information, use the fax send right-header global configuration command. Use the no form of this command to disable the selected options.
fax send right-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
no fax send right-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}Syntax Description
Defaults
No connection
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the AS5300's text-to-fax converter. When this conversion is performed, this fax send right-header command is used to indicate what header information should be added to right top of those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers and the AS5300's software does not modify TIFF attachments.
This command lets you configure multiple options at once—meaning that you can combine one or more wildcards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the date of the fax as the right fax header information:
configure terminalfax send right-header $a$The following example configures the company name "Widget" and its address as the right fax header information:
configure terminalfax send right-header widget $s$Related Commands
fax send center-header
Specifies the data that will appear in the center in the fax header.
fax send left-header
Specifies the data that will appear on the left in the fax header.
fax send transmitting-subscriber
To define the transmitting subscriber identifier (TSI), use the fax send transmitting-subscriber global configuration command. Use the no form of this command to disable the configured value.
fax send transmitting-subscriber {$s$ | string}
no fax send transmitting-subscriber {$s$ | string}Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
The transmitting subscriber number is the number displayed in the LCD of the receiving fax device. Typically, with a standard Group 3 fax device, this is the telephone number associated with the transmitting or sending fax device. This command defines the TSI.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures the company's name (as captured by the on-ramp from the sending fax machine as +18005551234) as the TSI:
configure terminalfax send transmitting-subscriber +14085551234image encoding
To select a specific encoding method for fax images associated with an MMoIP dial peer, use the image encoding dial-peer configuration command. Use the no form of this command to restore the default value.
image encoding{mh | mr | mmr | passthrough}
no image encoding{mh | mr | mmr | passthrough}Syntax Description
Defaults
Passthrough
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the image encoding command to specify an encoding method for e-mail fax TIFF images for a specific MMoIP dial peer. This command applies primarily to the on-ramp MMoIP dial peer. Although you can optionally create an off-ramp dial peer and configure a particular image encoding value for that off-ramp call leg, Store and Forward Fax ignores the off-ramp MMoIP setting and transmits the file using Modified Huffman encoding.
There are four available encoding methods:
Modified Huffman (MH)—One-dimensional data compression scheme that compresses data in only one direction (horizontal). Modified Huffman compression does not allow the transmission of redundant data. This encoding method produces the largest image file size.
Modified Read (MR)—Two-dimensional data compression scheme (used by fax devices) that handles the data compression of the vertical line and that concentrates on the space between lines and within given characters.
Modified Modified Read (MMR)—Data compression scheme used by newer Group 3 fax devices. This encoding method produces the smallest possible image file size and is slightly more efficient than Modified Read.
Passthrough—No encoding method will be applied to the image—meaning that the image will be encoded by whatever encoding method is used by the fax device.
The IETF standard for transmitting fax TIFF images is Modified Huffman encoding with fine or standard resolution. RFC 2301 requires compliant receivers support TIFF images with MH encoding and fine or standard resolution. If a receiver supports features beyond this minimal requirement, you might want to configure the Cisco AS5300 to send enhanced-quality documents to that receiver.
The primary reason to use a different encoding scheme from MH is to save network bandwidth. MH ensures interoperability with all Internet fax devices but it is the least efficient of the encoding schemes for transmitting fax TIFF images. For most images, MR is more efficient than MH and MMR is more efficient than MR. If you know the recipient is capable of receiving more efficient encodings than just MH, Store and Forward Fax allows you to send the most efficient encoding the recipient can process. For end-to-end closed networks, you can choose any encoding scheme because the off-ramp gateway can process MH, MR, and MMR.
Another factor to take into account is the viewing software. Many viewing applications (for example, those that come with Windows `95 or Windows NT) are able to display MH, MR, and MMR. Therefore you should decide, based on the viewing application and the available bandwidth, which encoding scheme is right for your network.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example selects Modified Modified Read as the encoding method for fax TIFF images sent by MMoIP dial peer 10:
dial-peer voice 10 mmoipimage encoding mmrRelated Commands
image-resolution
Specifies a particular fax image resolution for a specific MMoIP dial peer.
image resolution
To specify a particular fax image resolution for a specific MMoIP dial peer, use the image resolution dial-peer configuration command. Use the no form of this command to restore the default value.
image resolution {fine | standard | superfine | passthrough}
no connection {fine | standard | superfine | passthrough}Syntax Description
Defaults
Passthrough
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the image resolution command to specify a specific resolution (in pixels per inch) for e-mail fax TIFF images sent by the specified MMoIP dial peer. This command applies primarily to the on-ramp MMoIP dial peer. Although you can optionally create an off-ramp dial peer and configure a particular image resolution value for that off-ramp call leg, Store and Forward Fax ignores the off-ramp MMoIP setting and transmits the file using fine resolution.
This command enables you to increase or decrease the resolution of a fax TIFF image, thereby changing not only the resolution but the size of the fax TIFF file. The IETF standard for transmitting fax TIFF images is Modified Huffman encoding with fine or standard resolution. The primary reason to configure a different resolution is to save network bandwidth.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example selects the resolution fine (meaning 204-by-196 pixels per inch) for e-mail fax TIFF images associated with MMoIP dial peer 10:
dial-peer voice 10 mmoipimage encoding mhimage resolution fineRelated Commands
image encoding
Specifies a specific encoding method for e-mail TIFF images for a specific MMoIP dial peer.
incoming called-number
To specify an incoming called number of an MMoIP or POTS dial peer, use the incoming called-number dial-peer configuration command. Use the no form of this command to reset the default value for this command.
incoming called-number string
no incoming called-number stringSyntax Description
string
Specifies the incoming called telephone number. Valid entries are any series of digits that specify the E.164 telephone number.
Defaults
No incoming called number is defined.
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the incoming-called number command to define the destination telephone number for a particular dial peer. For the on-ramp POTS dial peer, this telephone number is the DNIS number of the incoming fax call. For the off-ramp MMoIP dial peer, this telephone number is the destination fax machine telephone number.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example configures the number (310)555-9261 as the incoming called number for MMoIP dial peer 10:
dial-peer voice 10 mmoipincoming 3105559261information-type
To select a particular information type for either an MMoIP or a POTS dial peer, use the information-type dial-peer configuration command. Use the no form of this command to reset the default value for this command.
information type {fax | voice}
no information type {fax | voice}Syntax Description
fax
Indicates that the information type has been set to store and forward fax.
voice
Indicates that the information type has been set to voice.
Defaults
Voice
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example sets the information type for MMoIP dial peer 10 to fax:
dial-peer voice 10 mmoipinformation-type fax
