RelayFax online help

 
Email Macros

Navigation:  RelayFax SMTP Client > Working with Faxes > Sending a Fax via an Email Client >

Email Macros

Print this Topic Previous pageReturn to chapter overviewNext page

When RelayFax processes an email message in preparation for faxing, it examines the message to determine where and to whom the fax should be sent. Most of the time this information will be specified on the TO: line, however it is possible to specify several key items within the email message itself. The following special macros can be placed within the body of an email message to achieve specific results. Each macro must appear on its own line and at the top of the message body:

AUTOEXTRACT: true

This macro tells the RelayFax Server to perform OCR on the attached TIF file and search for faxnumbers.

AUTOEXTRACTKEY: true

If AUTOEXTRACT is true, then this macro contains the string to search for when looking for recipient fax numbers.

AUTOEXTRACTNAME: true

If AUTOEXTRACT is true, then this macro contains the string to search for when looking for the recipient name.

AUTOEXTRACTCOMPANY: true

If AUTOEXTRACT is true, then this macro contains the string to search for when looking for the recipient company name.

AUTOEXTRACTFILE: true

If AUTOEXTRACT is true, then this macro contains the string to search for when looking for the name of a comment file to include on the cover page.

AUTOEXTRACTSUBJECT: true

If AUTOEXTRACT is true, then this macro contains the string to search for when looking for the fax subject.

AUTOEXTRACTEACHPAGESEPARATE: true

If AUTOEXTRACT is true, this macro processes each page of the attached TIF separately. This option is used when each page of a single printout should be sent to a separate user.

EMAILTO: user@example.com

This macro specifies an email address to which to send a copy of the fax. You can include any number of these macros. Each email recipient receives a customized cover page, and the fax document will be attached in the image format  designated in Imaging Options.

FAXPASSWORD: Password

Used for including your fax password within the message. If RelayFax is configured to require a password then you must use this macro to include it, when sending a fax via an email client.

FAXID: Text

This macro specifies the fax ID used when RelayFax sends a fax. This information is transmitted to the receiving fax machine.

FAXSUBJECT: Text

This macro specifies the subject of the fax to "Text". This information appears on the cover page.

FROMNAME: Text

This macro specifies real name of the sender of the fax to "Text".

FROMLINE: Text -or-

FROMADDRESS: Text

Either of these macros specifies the email address of the sender of the fax. The value must be an email address.

FAXNUMBER: Parms

This macro specifies the one fax recipient. ‘Parms' can specify a fax number only or a fax number + recipient name + recipient company name.

Ex: 555-1212

Or 555-1212, Jerry Donald, Alt-N Tech

Or 555-1212, "Hathcock, Arvel", "Alt-N Tech, LTD."

STREET1:Text

The sender's street address.

STREET2:Text

The sender's secondary address, or second line of their street address.

CITY:Text

The sender's city.

STATE:Text

The sender's state or province.

ZIP:Text

Sender's zip or postal code.

ZIPCITY: true

This macro specifies the order used in the

sender's address. If "true," then the order is zip, city, and state.

The default is "false": city, state, and zip.

HOMEPHONE:Text

This is the sender's home telephone number.

HOMEFAX:Text

This is the sender's home fax number.

BUSPHONE:Text

The sender's business phone number.

BUSFAX:Text

Sender's business fax number.

BILLINGCODE:Text

The billing code of the sender.

CCNUMBER: Parms

Use this macro to specify additional fax recipients. You can use as many of these macros as you need. Specify a single recipient per macro. ‘Parms' can specify a fax number only or a fax number + recipient name + recipient company name.

Ex: 555-1212

Or 555-1212, Jerry Donald, Alt-N Tech

Or 555-1212, "Hathcock, Arvel", "Alt-N Tech, LTD."

PORT: Number

This macro specifies the port that the fax should be sent on. Use care to ensure that you specify a valid port.

FROMCOMPANY: Text

This macro specifies the company name of the sender of the fax.

FROMPHONE: Text

This macro specifies the voice telephone number of the sender of the fax. This is the voice number value that is used in RelayFax's template files.

FROMFAX: Text

This macro specifies the fax number of the sender of the fax (typically the RelayFax Server's fax number).

CONFIRMSEND: true

This macro specifies that the sender of the fax wishes to receive a confirmation message when the fax has been successfully sent. The value of this macro should be the word "true".

ATTACHMENT: Path

Causes the attachment specified in the path to be included in the fax message. The file path must be accessible to the RelayFax server for it to be attached.

COVERPAGE: Path

This macro specifies the cover page that will be used for this fax. "Path" must specify a valid .COV file accessible to the RelayFax Server.

PREFIX: Text

This macro specifies a prefix to the fax number such as "*70" or "9,".

IGNOREBODY:

This macro prevents RelayFax from including the email body in the comments field. The body is still scanned for macros.

COMMENTS: Text

This macro specifies the text that will appear in the NOTES or COMMENTS section of the cover page. You can specify more than one line of comment text by placing "%e" into the text where a line break should appear.

SCHEDULE: mm/dd/yyyy ##:## am/pm

Designates a specific date and time to send the fax.

Example: SCHEDULE: 01/01/2001 05:30 PM

NOTE: The day and date parameters must be two characters: 01, 02, etc. The year must be four. The hour must be 01-12 with AM or PM following the minutes.

PRIORITY: 00-100

Sets a priority value for the fax. 00 is the highest priority and 100 is the lowest. Messages will always be faxed in the order of their priority setting. When no priority setting is present, they will be treated as "normal" with a setting of 50.

WAITFORANSWER: Number

This macro specifies how long RelayFax will wait for the receiving fax machine to answer. This is a value in seconds.

RETRYATTEMPTS: Number

This macro specifies how many times RelayFax will retry a failed fax attempt.

RETRYDELAY: Number

This macro specifies the number of seconds RelayFax will wait between subsequent fax attempts.

NOCOVERPAGE: true

This macro will prevent RelayFax from generating a dynamic cover page and sending it along with your fax. This is useful for situations in which you either do not want a cover page or the first printed page of your document is the cover page for the fax.

BANNERTEXT: Text

This macro specifies the text that appears at the top of each faxed page. You can use the special banner characters here. See the Banner Text & Formatting Characters for more information.

---Example Start---

From: Frank.Thomas@example.com

To: "555-1212, Eddie Filewood, "Forest Park Lanes, Front Desk"" <RelayFax@example.com>

Subject: My time.

 

FROMNAME: Frank Thomas

FROMCOMPANY: Forest Park Lanes, Inc.

PRIORITY: 00

COMMENTS: Say, hit me in! I be in ina minute. %e Tell me I'm a lyin'. %e Frank

 

---Example End---