wsdlSendQmail
Description
Send Qmail using WSDL call with possibilities to add attachments in base 64 encoded string format
Input
Parameter | Data type | Format/example | Comment |
apiKey | String | abcz1234567890abcz | String of various length and combination of characters. This should be the API key for the user specified in “toPersId”. |
toPersId | Integer | 334 | Quinyx persId. Set to 0 or skip if sending to unit manager or to manager group(relates to Classic configuration, deprecated). |
sendToManagerType | Integer | 1 | Set if sending to unit manager or manager group. |
subject | String | Hello | Subject in Qmail |
msg | String | Qmail message | |
fromPersId | Integer | Sender. Quinyx persId. If set to 0 or skipped, sender is set to unit manager as defined on the unit card. | |
attachments | array of MailAttachement | <attachments soapenc:arrayType="flex:MailAttachment[]"><item><fileName>firstfisle.txt</fileName><fileContent>JVBERi0xL</fileContent></item><item><fileName>firstfile.txt</fileName><fileContent>JVBERi0xL</fileContent></item></attachments> | Each MailAttachment must have two values:fileName and fileContent.You can include max 10 attachments per qmail.fileContent should be base64 encoded string. |
attachmentsArePayslips | Boolean | Optional. Requires Mobile payslip is activated for the customer.true=1 false=0 | If true AND if attachments are provided, marks all attachments as payslips (so mobile users can see their payslips) |
allowfromPersIdOutsideOfUnit | Integer | Not mandatory0 = fromPersId must belong to same unit as recipient (toPersId)1 = fromPersId must belong to same customer but can belong to another unit within the organisation | |
isMarkedAsImportant | Integer | Not mandatory0 = Not important1 = Important |
Output
Parameter | Data type | Format/example | Comment |
toPersId | Integer | ||
subject | String | ||
msg | String | ||
fromPersId | Integer | 100100 | |
attachments | array | 0 |
Example request
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uri="uri:FlexForce" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<uri:wsdlSendQmail soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<apiKey xsi:type="xsd:string">1234-1234-1234-1234</apiKey>
<mail xsi:type="flex:Mails" soapenc:arrayType="flex:Mail[]" xmlns:flex="https://test.quinyx.com/soap/FlexForce">
<item xsi:type="tns:Mail">
<toPersId xsi:type="xsd:int">4</toPersId>
<subject xsi:type="xsd:string">Stuff to note</subject>
<msg xsi:type="xsd:string">1. Fun stuff 2. Other stuff</msg>
<fromPersId xsi:type="xsd:int">2</fromPersId>
<isMarkedAsImportant xsi:type="xsd:int">0</isMarkedAsImportant>
</item>
</mail>
</uri:wsdlSendQmail>
</soapenv:Body>
</soapenv:Envelope>
Change log
Date | Released in version | Description | Author |
2019-12-18 | 366 | Added attachmentsArePayslips | Boško Pešić |
Quinyx AB | info@quinyx.com | www.quinyx.com
© Quinyx. All rights reserved.