MESSAGE_INFO NSSOAP Classes

The MESSAGE_INFO class contains fields for specifying various feature settings when calling send_message.

class MESSAGE_INFO {
  string         sender_name; // Sender name
  string         sender_email; // Sender e-mail address
  string         sender_company; // Sender company
  string         sender_fax_number; // Sender fax number
  string         sender_voice_number; // Sender voice number
  string         subject; // Subject of message
  TRANSFER_TYPE  transfer_type; // Fax or e-mail message
  FAX_RESOLUTION fax_resolution; // Fax page resolution
  FAX_COVER      fax_cover; // Send cover or not
  string         billing_code; // A billing code to be logged
  string         cover_template; // A server-stored cover template
  DateTime       schedule_time_utc; // Scheduled delivery time
  string         port_to_use; // Fax port on server to use
  ON_COMPLETION  on_completion; // Post-completion action
  string         custom_value; // A user-defined value
}


Members:
sender_name Specifies the individual who is sending the fax.  This name appears in the fax header of each page, and on the fax cover page if it contains a $(SenderName) field. This field is optional and can be null.
 
sender_email Specifies the From e-mail address for an e-mail message. This field is optional and can be null.
 
sender_company Specifies the sender company name that will appear on the fax cover page if it contains a $(SenderCompany) field. This field is optional and can be null.
 
sender_fax_number Specifies the sender fax number that will appear on the fax cover page if it contains a $(SenderFax) field. This field is optional and can be null.
 
sender_voice_number Specifies the sender voice number that will appear on the fax cover page if it contains a $(SenderVoice) field. This field is optional and can be null.
 
subject Specifies the subject of the message that will appear on the fax cover page if it contains a $(Subject) field. This field is optional and can be null.
 
transfer_type Specifies whether the message will be prepared for fax or e-mail delivery.  Must be set to a member of the TRANSFER_TYPE enumeration.

enum TRANSFER_TYPE {
  Fax, // Prepare message for fax delivery
  Email  
}

fax_resolution Specifies the fax image resolution.  Must be set to a member of the FAX_RESOLUTION enumeration.

enum FAX_RESOLUTION {
  Default, // Use the fax server default fax resolution
  Fine,
  Standard
}

fax_cover Specifies whether to send a fax cover or not.  Must be set to a member of the FAX_COVER enumeration.  If set to Default, then the cover template provided in the MESSAGE_INFO object will be used to create the cover, or if no cover template is provided, then the fax server will use the default cover template for the sending user. 

enum FAX_COVER {
  Default, // Send a fax cover
  DontSend
}

billing_code A string value (up to 31 characters) that will be logged with this message once it is competed, in the Custom_Billing_Code column.  This field is optional and can be null.
 
cover_template A cover template name that the fax server will use when creating the fax cover for this message.  The template name must match the name of a template stored on the fax server, in the Templates directory.  If the template is private for the sending user, then the template name must include the user's name like so:

    User\MyTemplate.rtf

This field is optional and can be null.
 
schedule_time_utc Specifies the date and time when this message becomes eligible for delivery.  The DateTime value must be in UTC (Coordiated Universal Time). This field is optional and does not need to be initialized.  When the message is submitted, if this field contains a DateTime that is earlier than the current date time (in UTC) then the message is immediately eligible for delivery.
 
port_to_use The name of a port on the fax server that this message should be sent with.  This field is optional and can be null.
 
on_completion Specifies an action to take upon completion of the message. Must be set to a member of the ON_COMPLETION enumeration.  A value of DeleteMessage will cause the message to be deleted once it is completed (either through the normal progression of sending a message, or by being aborted), but the message will still be logged.

enum ON_COMPLETION {
  Nothing,  
  DeleteMessage // Delete the message
}

custom_value This field can be set to a string value that will be saved with a new message, so that it can be retrieved later when calling get_message_q or get_message. This field is optional and can be null.

Remarks:
The MESSAGE_INFO class is used to provide extended feature settings to send_message.  Only desired fields need to be initialized with a value, like so:

    MESSAGE_INFO mi = new MESSAGE_INFO();
    mi.on_completion  = ON_COMPLETION.DeleteMessage;

    SEND_MESSAGE_RESULT smr =  ns.send_message("supervisor","",mi,recipients,content);

Revisions:
For NSSoap version 1.1 the page_style setting was moved to the CONTENT class.

See Also:
send_message, get_message_q, get_message