Q_MESSAGE NSSOAP Classes

The Q_MESSAGE class contains information about a message that is on the fax server.

class Q_MESSAGE {
  string            message_handle; // Message handle
  MESSAGE_TYPE      message_type; // Send or Receive message
  TRANSFER_TYPE     transfer_type; // Fax or Email message
  bool              is_completed; // Tells if message is completed
  int               completion_code; // Numeric completion code
  string            completion_string; // Completion string
  string            user_name; // Owner of the message
  string            subject; // Message subject
  string            sender_name; // Sender name of message
  string            sender_email; // Sender e-mail of message
  string            billing_code; // Billing code
  DateTime          submit_time_utc; // When the message was submitted
  DateTime          schedule_time_utc; // Scheduled delivery time
  string            custom_value; // Custom value sent with message
  CONNECTION_INFO[] connection_info; // Connection details for message
  CONTENT_INFO[]    content_info; // Message content
}


Members:
message_handle Specifies the message handle for the message.
 
message_type Specifies whether the message is a Send or Receive message.  Must be a member of the MESSAGE_TYPE enumeration.
 
enum MESSAGE_TYPE {
  Send, // A send, sending or sent message
  Receive // A Receiving or Received message
}

transfer_type Specifies whether the message is a Fax or E-mail message.  Must be a member of the TRANSFER_TYPE enumeration.
 
enum TRANSFER_TYPE {  
  Fax, // A Fax message
  Email // An E-mail message
}  

is_completed Specifies whether the message has completed the process of sending or receiving.  This field will always be true for messages retrieved from the Sent or Received queue. When a Q_MESSAGE object is retrieved by calling get_message, where a message could be in any fax server queue, this field can be used to determine if the retrieved message is completed.

Important: To determine if a completed message was successfully sent or received, you must examine the completion_code field.
 
completion_code Specifies a numeric completion code for a sent or received message.  This field is valid only when the is_completed field is set to true.

For a received message, or a sent message with one recipient, the completion_code field contains the entire message completion code.  For a multi-recipient sent message, this field contains a summary status for the message, and the completion_code field in each CONNECTION_INFO object (from the connection_info field) contains the specific completion code per recipient.

A completion_code value of zero represents a successfully sent or received message.  A non-zero value is an error code that represents a failed message and specifies the reason for the failure.  The completion_string field contains a text message that corresponds to this value.

To lookup the text message associated with a completion code, you can run a utility that is installed in the NET SatisFAXtion directory, called fb_msg_view.exe.  After entering the numeric error code in the Hex or Dec fields, the text of that error code will be displayed.


 
completion_string Specifies a completion string for a sent or received message that corresponds to the numeric completion_code value.  This field is valid only when the is_completed field is set to true.
 
user_name Specifies the fax server user who is the owner of the message.
 
subject Specifies the subject of the message.
 
sender_name Specifies the sender name provided when this message was submitted.
 
sender_email Specifies the sender e-mail address provided when this message was submitted.
 
billing_code Specifies the billing code that was provided when a sent message was submitted, or the billing code for a fax server user who received an inbound message.
 
submit_time_utc Specifies the time that a send message was submitted, or when a received message arrived, in Coordinated Universal Time (UTC).
 
schedule_time_utc Specifies the scheduled delivery time for a sent message, in Coordinated Universal Time (UTC).
 
custom_value Contains the custom value string that was provided in a MESSAGE_INFO object when the message was originally submitted with send_message.
 
connection_info Contains an array of CONNECTION_INFO objects that provide detail about the delivery of the message.

For a received message, or a sent message with one recipient this array will contain only one object.  For a multi-recipient sent message, this array will contain one CONNECTION_INFO object for each recipient.
 
content_info Contains an array of CONTENT_INFO objects that provides information about the content of the message.

Remarks:
A Q_MESSAGE object is obtained by calling get_message or get_message_q.

See Also:
get_message_q, get_message