FaxBack Developer NSSOAP - delete

delete_message

The delete_message method deletes any message at the server. If the message is currently queued for transmission or is currently transmitting, this method will first abort the transmission and then delete the message from the queue.

DELETE_MESSAGE_RESULT delete_message(
string user_name,	// Fax server user name
string user_password,	// Fax server user password
string message_handle	// Message to delete
)

Parameters:

user_name	A NET SatisFAXtion user name.
user_password	The password for the user.
message_handle	The handle of the message to delete. To obtain a message handle, call get_message_q and use the message_handle field of a Q_MESSAGE object, or use the message handle returned from send_message.

Return Value:

A DELETE_MESSAGE_RESULT object containing a result code and string.

Example:

public void delete_message(string message_handle)
  {
  NSSOAP ns = new NSSOAP();
  
  ns.delete_message("supervisor","",message_handle);
  }