SOAP API method User_sendEmail

Back to API references

Description
The message is sent in the layout of the POM environment, with the application top put above the message. The message that is sent will be added to the total number of messages sent by this user.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object User. The method only applies to the user with this id.
Parameter 'subject' : string
The subject of the email
Parameter 'html' : string
HTML source code of the message to send
Parameter 'text' : string
(Optional) textonly version of the e-mail
Parameter 'attachments' : Collection of type 'attachments'
(Optional) Attachments
Parameter 'images' : Collection of type 'images'
(Optional) Images
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'value' : boolean

Structure 'attachments'
This structure attachments was mentioned above. This structure has the following properties:
Property '' : string

Structure 'images'
This structure images was mentioned above. This structure has the following properties:
Property '' : string

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt