SOAP API method ProcessedEmailing_snapshot

Back to API references

Description
The snapshot of this mailing.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object ProcessedEmailing. The method only applies to the processedemailing with this id.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'pdfdocumentsnapshot' : Structure of type 'pdfdocumentsnapshot'
Return value 'emailingdocumentsnapshot' : Structure of type 'emailingdocumentsnapshot'
Return value 'smsdocumentsnapshot' : Structure of type 'smsdocumentsnapshot'

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

Structure 'pdfdocumentsnapshot'
This structure pdfdocumentsnapshot was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the snapshot.
Property 'source' : string
The source of the snapshot.
Property 'pagecount' : int
The number of pages in the snapshot.
Property 'name' : string
The name of the snapshot.
Property 'faxheader' : string
The headerline above the fax.
Property 'language' : string
The language in which this snapshot is displayed.

Structure 'emailingdocumentsnapshot'
This structure emailingdocumentsnapshot was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the emailingdocumentsnapshot.
Property 'name' : string
The name of the emailingdocumentsnapshot.
Property 'headers' : string
The additional headers of the emailingdocumentsnapshot.
Property 'source' : string
The source of the emailingdocumentsnapshot.
Property 'textversion' : string
The textversion of the emailingdocumentsnapshot.
Property 'subject' : string
The subject of the emailingdocumentsnapshot.
Property 'timestamp' : timestamp
The timestamp of the emailingdocumentsnapshot.
Property 'charset' : string
The charset of the emailingdocumentsnapshot.
Property 'language' : string
The language of the emailingdocumentsnapshot.
Property 'priority_indicator' : string
Getting the priority header for emails who use this document snapshot.
Property 'unsubscribe_header' : string
Should the list-unsubscribe header be sent with the mailing.
Property 'htmlEscaping' : string
Check if the webform is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this snapshot

Structure 'smsdocumentsnapshot'
This structure smsdocumentsnapshot was mentioned above. This structure has the following properties:
Property 'id' : int
The unique identifier of the sms document snapshot in the environment.
Property 'name' : string
The name of the sms document snapshot.
Property 'timestamp' : timestamp
The timestamp when the sms document snapshot was created.
Property 'message' : string
The message that was sent.
Property 'from' : string
The from address of the sms document snapshot.
Property 'language' : string
The language of the sms document snapshot.
Property 'smartyVersion' : integer
What smarty version is used to render this SmsDocumentSnapshot