Send Fax Module Documentation

Module Overview (Technical)
Module Overview (Commercial/Business)
Module Overview (End User/Administrator)
Sending Process
Supported Formats
Common Scenarios & Examples
Limitations & Important Notes
Troubleshooting Tips
Glossary

---

1. Module Overview (Technical)

What Is Send Fax?

Send Fax is a web-based fax transmission interface that allows users to send documents as faxes through configured fax devices. Documents are uploaded, converted if necessary, and transmitted via FreeSWITCH's fax engine.

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                   Send Fax Architecture                         │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        FaxSendingPage.tsx                                │   │
│  │                                                          │   │
│  │  1. Select fax device                                    │   │
│  │  2. Enter destination number                             │   │
│  │  3. Upload PDF/TIFF document                             │   │
│  │  4. Click "Send Fax"                                     │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ API Call                                                │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Backend Fax API                                   │   │
│  │                                                          │   │
│  │  1. Validate file and device                             │   │
│  │  2. Store document temporarily                           │   │
│  │  3. Convert PDF to TIFF if needed                        │   │
│  │  4. Originate call via FreeSWITCH                        │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ FreeSWITCH Originate                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        fax/fax_send.lua                                  │   │
│  │                                                          │   │
│  │  1. Load fax device config from public.fax_devices       │   │
│  │  2. Configure T.38 / ECM settings                        │   │
│  │  3. Connect to destination                               │   │
│  │  4. Transmit fax (txfax)                                 │   │
│  │  5. Send email notification                              │   │
│  │  6. Log to public.fax_logs                               │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼                                                         │
│  Remote Fax Machine                                             │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

Table	Purpose
`public.fax_devices`	Device configuration
`public.fax_logs`	Transmission logs

Key Files

File	Description
`modules/faxSending/FaxSendingPage.tsx`	Frontend send interface
`modules/faxSending/api/faxSendingApi.ts`	API calls
`lua/main/xml_handlers/fax/fax_send.lua`	Transmission handler

---

2. Module Overview (Commercial/Business)

Business Value

Send Fax provides web-based fax transmission:

Without Send Fax	With Send Fax
Physical fax machine	Web interface
Print documents	Upload PDF
Manual dialing	Click to send
No status tracking	Email notifications

Use Cases

Document Transmission

- Send contracts and agreements

- Transmit signed documents

Business Communications

- Send invoices to vendors

- Transmit purchase orders

Healthcare/Legal

- HIPAA-compliant fax

- Court document filing

Remote Work

- Fax from anywhere

- No physical equipment

Feature Highlights

Feature	Benefit
PDF Support	No conversion needed
TIFF Support	Native fax format
T.38 Protocol	Reliable FoIP
Auto-Retry	Handle busy lines
Notifications	Email on success/fail
Logging	Full audit trail

---

3. Module Overview (End User/Administrator)

What Can You Do?

Select outbound fax device
Enter destination number
Upload PDF or TIFF document
Send fax with one click
Receive email notifications
View transmission status

Send Fax Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Send Fax                                           │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Section: Send Fax                                              │
│  ├─ Fax Device: [Main Office Fax ▼]                            │
│  │   Only devices with outbound capability shown                │
│  │                                                              │
│  └─ Destination Number: [+15551234567            ]             │
│      Include country code for international faxes               │
│                                                                 │
│  Section: Document Upload                                       │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │                                                          │   │
│  │         📄 Drop your document here                       │   │
│  │              or click to browse                          │   │
│  │                                                          │   │
│  │         [Browse Files]                                   │   │
│  │                                                          │   │
│  │    Supported formats: PDF, TIFF (max 10 MB)             │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
│  ℹ️ Important Information:                                      │
│  • Supported formats: PDF and TIFF                              │
│  • Maximum file size: 10 MB                                     │
│  • Email notifications based on device configuration            │
│  • T.38 protocol used if enabled and supported                  │
│                                                                 │
│  [Send Fax] [Cancel]                                            │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

PDF Format: Upload PDFs directly - they're converted automatically.

TIP

Country Code: Always include country code (e.g., +1) for reliable delivery.

CAUTION

File Size: Maximum 10 MB per document.

---

4. Sending Process

Step-by-Step Flow

Select Device

- Choose outbound-capable fax device

- Device determines caller ID and settings

Enter Destination

- Full phone number with country code

- Example: +15551234567

Upload Document

- Drag and drop or browse

- PDF or TIFF format

Send

- Click "Send Fax"

- System queues transmission

Transmission

- FreeSWITCH originates call

- T.38 negotiation if enabled

- Document transmitted

Notification

- Email sent on success/failure

- Log recorded in database

Retries

Setting	Default	Description
Max Retries	3	Total retry attempts
Retry Interval	300s	Seconds between retries

---

5. Supported Formats

PDF Documents

Aspect	Details
Format	PDF 1.0 - 2.0
Conversion	Auto-converted to TIFF
Pages	Multi-page supported
Color	Converted to B&W

TIFF Documents

Aspect	Details
Format	TIFF (Group 3/4 fax)
Native	No conversion needed
Pages	Multi-page supported
Compression	G3/G4 fax compression

Size Limits

Limit	Value
Max File Size	10 MB
Max Pages	Depends on document

---

6. Common Scenarios & Examples

Scenario 1: Send Contract

Select fax device: "Sales Fax"
Destination: +14155551234
Upload: contract.pdf
Click "Send Fax"
Receive success email

Scenario 2: International Fax

Select fax device: "International Fax"
Destination: +442071234567 (UK)
Upload: invoice.pdf
Send and wait for confirmation

Scenario 3: Multi-Page Document

Upload multi-page PDF
System converts all pages
Transmits as single fax
Pages sent sequentially

---

7. Limitations & Important Notes

Technical Notes

NOTE

Outbound Only: This module is for sending only. See Fax Devices for receiving.