 |
This method is used to send a secure mail package.
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| TRID | See Complex Type: TRID | Mandatory - cannot be null or empty | The settings for the package. |
| Properties | 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 recipient of the package (semi colon delimited) |
| subjectMetaApplies | xsd:boolean | Optional – can be null (indicates false) | Whether the subject is formatted according to the metadata configuration |
| additionalauthentication | xsd:boolean | Optional – can be null (indicates false) | This is used to determine whether the recipient must provide additional authentication before being permitted access to the package |
| signable | xsd:boolean | Optional – can be null (indicates false) | This is used to determine whether the recipient of the package will be requested to sign (or reject) the package |
| 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 – can be null or an empty array if no attachments are to be sent | The array of attachments |
| packagetype | xsd:string | Mandatory – cannot be null or empty. | This is used to determine which TILA/RESPA package type the package is |
| applicationdatetime | xsd:date/time | Conditional (see paper out defining properties table below) | This is used to determine the application date/time for the TILA/RESPA package |
| consummationdatetime | xsd:date/time | Conditional (see paper out defining properties table below) | This is used to determine the application date/time for the TILA/RESPA package |
| shipbeforebusinessdays | xsd:integer | Conditional (see paper out defining properties table below) | This is used to identify how many mutual business days before the consummation date the package should expire to paper for a Closing Disclosure |
| subject | xsd:string | Mandatory – cannot be null or empty | The subject of the package |
| absoluteexpirydatetime | xsd:date/time | Conditional (see paper out defining properties table below) | This is used to override SDX’s paper expiry date/time calculations |
| changecircumstancedatetime | xsd:date/time | Conditional (see paper out defining properties table below) | This is used to determine the change circumstance date/time for a Revised Loan Estimate |
✓ = Mandatory (will be used to work out paper expiry date/time)
* = Optional (will not be used to work out the paper expiry date/time but will be stored for record)
*T = Optional (but if provided will trump all other logic)
X = Not wanted (will be completely ignored)
| TR-ID-ILE-WN | TR-ID-ILE-WY | TR-ID-RLE-RY | TR-ID-RLE-RN-WY | TR-ID-RLE-RN-WN | TR-ID-RLE-TC | TR-ID-ICD | TR-ID-RCD | TR-ID-RCD-TC | TR-ID-RCD-PC | TR-ID-MISC | |
|---|---|---|---|---|---|---|---|---|---|---|---|
| packagetype | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| applicationdatetime | ✓ | ✓ | * | * | * | * | * | * | * | * | * |
| changecircumstancedatetime | X | X | * | * | ✓ | * | X | * | * | * | * |
| absoluteexpirydatetime | *T | *T | *T | *T | *T | ✓ | *T | *T | ✓ | ✓ | ✓ |
| consummationdatetime | * | * | * | * | * | * | ✓ | ✓ | * | * | * |
| shipbeforebusinessdays | X | X | X | X | X | X | * | * | X | X | X |
|