SOAP API method WebDocument_size

Back to API references

Description
This property will help determine the aproximate size of the document. The handleimages parameter can be used to specify how images are handled. If it is set to 'external' the size of the email is returned, with the size of all externally hosted images added to it, and if it is set to 'ignore', the image sizes are not included in the result.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object WebDocument. The method only applies to the webdocument with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'handleimages' : string
Possible valid values are 'external' or 'ignore'
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'value' : int

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