Back to API references

SOAP API method User_sendEmail

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

Name Type Description
id * int Unique identifier (id) of the object User. The method only applies to the user with this id.
subject * string The subject of the email
html * string HTML source code of the message to send
text string (Optional) textonly version of the e-mail
attachments Collection of type 'attachments' (Optional) Attachments
images Collection of type 'images' (Optional) Images
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
value boolean

Structure 'attachments'

Name Type Description
string

Structure 'images'

Name Type Description
string

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt