 |
This method is used to send a secure mail package.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| username | xsd:string | mandatory – cannot be null or empty | The username of the registered user who is sending the package |
| password | xsd:string | mandatory – cannot be null or empty | The password of the registered user who is sending the package |
| encodedPassword | xsd:boolean | optional – can be null (indicates false) | Indicates whether the password parameter is MD5 encoded |
| replyTo | xsd:string | optional – can be null or empty | An optional parameter which denotes the user from whom a package is to be sent on behalf of. If the user exists, then they will become the sender of the package instead of username. |
| recipients | xsd:string | mandatory – cannot be null or empty | An array of the usernames of the intended recipients of the package |
| subject | xsd:string | mandatory – cannot be null or empty | The subject of the package |
| subjectMetaApplies | xsd:boolean | optional – can be null or empty (indicates false) | Whether the subject is formatted according to meta-data configuration |
| body | xsd:string | optional – can be null or empty | The body of the package |
| attachments | Array of the Attachments complex type (see Complex Type: Attachment) | optional – may be null or an empty array if no attachments are to be sent | The array of attachments |
| settings | Array of the Attachments complex type (see Complex Type: Attachment) | optional – may be null if the sender’s default settings are to be used | The settings for the package |
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| filename | xsd:string | mandatory – cannot be null or empty | The attachment filename (e.g. mortgage1.doc) |
| contentType | xsd:string | optional – can be null or empty | The MIME content type of the attachment (e.g. application/msword) |
| content | array of xsd:base64Binary | mandatory – cannot be null or empty | This is the content of the attachment |
| compresses | xsd:boolean | optional – can be null or empty (indicates false) | Indicates whether the content is gzip compressed |
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| expirySetting | xsd:boolean | optional – can be null or empty (indicates false) | This specifies whether or not the secure package should expire (i.e. become unavailable to all recipients) after a certain date |
| expiry | xsd:dateTime | optional – can be null or empty (default setting will apply) | If expirySetting is true, this specified the date after which the package will expire |
| viewingLimitSetting | xsd:boolean | optional – can be null or empty (indicates false) | This specifies whether or not the secure package should have a viewing limit (i.e. once the viewing limit is reached, the package will become unavailable to that recipient) |
| viewingLimit | xsd:short | optional – can be null or empty (default setting will apply) | If viewingLimitSetting is true, this specified the number of times a recipient can open a package after which it will become unavailable for viewing |
Type: xsd:string
A successful response will at a minimum, return <SENT_ID>11056</SENT_ID>
Other fields may also be present depending on the skin configuration. An error will return “ERROR” - an error occurred. This is followed by a description of the error (e.g. “ERROR : No recipients provided”)
|