Message information
When a message is submitted to the server for sending (after creating a CONTROL file and DATA file for the message), an entry is made in the INFO file in the user's OUT directory. This entry includes the file name of the message, the comment and subject line associated with it, and the current status of the message (converting, sending etc). The server is then notified that a new message is ready for sending, and will add the message to its queue.
The status field is updated by the server program as the message is processed. When the server completes processing of the message (and the status has changed to OK or FAILED) the message may be deleted. This is done by removing the INFO file entry, then deleting the message files, and may be done either from the client or via the API.
Details of a message in the INFO file may be obtained using the ZfxGetMsgInfoEx or ZfxGetMsgListEx routines, giving details of a single message or all messages in the INFO file respectively. These store the information in a data structure of type ZFMSGINFOEX. The fields in this structure are as follows.
Field |
Description |
Status |
Current status of message. This is a variable of type ZFMSGSTATUS, and the value is one of the ZFMSG_??? values listed below. Message status variables are given below. |
szBody |
Character string giving the body name of the message files (ie the file name without extension or preceding '.'). The maximum length of this string (excluding terminating NULL) is given by the constant ZFMSG_BODY_LEN. |
szComment |
Character string giving the description of the message being sent (as displayed on the right in the client main display). The maximum length of this string (excluding terminating NULL) is given by the constant ZFMSG_COMMENT_LEN. |
szSubject |
Character string giving the subject of the message being sent (as displayed on the right in the client main display). The maximum length of this string (excluding terminating NULL) is given by the constant ZFMSG_SUBJECT_LEN. |
UserStatus |
Current status of message in relation to the user. This is a variable of type ZFMSGUSERSTATUS, and the value is one of the ZFMSG_??? values listed below. User status variables are given below. |
Type |
Type of message. This is a variable of type ZFMSGTYPE, and the value is one of the ZFTYPE_??? values listed below. Type variables are given below. |
szOrganisation |
Character string giving the organisation field for the message being sent. The maximum length of this string (excluding terminating NULL) is given by the constant ZFMSG_COMMENT_LEN. |
The following list gives the possible states for a message (variable of type ZFMSGSTATUS).
Message state |
Description |
ZFMSG_ADDING |
Message being added to queue |
ZFMSG_HELD |
Message held by user |
ZFMSG_DEFERRED |
Message waiting for sending after a specific time, either because that time was specified when the message was submitted, or the user does not have sufficient permissions to send until after the given time. |
ZFMSG_WAITING |
Waiting for conversion or for a free device to send the message. |
ZFMSG_CONVERTING |
Preparing the message for sending (merging with letterhead, creating coversheet etc). |
ZFMSG_CONNECTING |
Dialling remote device, or connecting to local printer etc. |
ZFMSG_SENDING |
Connection made, sending message to remote device. |
ZFMSG_SUB_ROUTER |
Passed to a remote Zetafax server for sending, but not yet acknowledged. |
ZFMSG_ACCEPT_REMOTE |
Message accepted for transmission by a remote Zetafax server. |
ZFMSG_SCANNING |
(not applicable) |
ZFMSG_ABORTING |
Processing an Abort request, waiting for device controller or convert program to cancel processing of the message. |
ZFMSG_INCOMING |
Being received by the device. |
ZFMSG_WAITING_SCAN_DOC |
(not applicable) |
ZFMSG_OK |
Completed (sent or received) successfully, with no errors. For sent messages the message may now be deleted (using the ZfxDeleteMsg function). For received messages the DATA file contains the received message, so should be saved (if required) before calling ZfxDeleteMsg. |
ZFMSG_FAILED |
Completed with one or more errors. Details of the errors that occurred are listed in the CONTROL file, although this would normally be checked manually. The message may now be deleted (using the ZfxDeleteMsg function). For received faxes any part of the message received before the error occurred will still be stored in the DATA file. |
ZFMSG_PREVIEW_OK |
(not applicable) |
ZFMSG_PREVIEW_FAILED |
(not applicable) |
User status
The following list gives the possible users states for a message (variable of type ZFMSGSTATUS).
Message state |
Description |
ZFMSG_U_UNKNOWN |
User Status unknown. |
ZFMSG_U_OK |
Message has been read by user. |
ZFMSG_U_AWAITING |
Message awaiting preview. |
ZFMSG_U_WAITING |
Waiting - i.e. unread. |
User status
The following list gives the possible values for the message type field (variable of type ZFMSGTYPE).
Type |
Description |
ZFTYPE_FAX |
Fax message. |
ZFTYPE_LAN |
Message for another Zetafax user (on the same LAN). |
ZFTYPE_SMS |
Text message. |
Related topics
Function error returns and reference
Message transmission history functions