SOAP API method reference

Description

The document that will be used for the mailing. Note that: In case of splitRunEmailing, this document is not set.

Parameters

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

Return values

Return value 'smsdocument' : Structure of type 'smsdocument'
Return value 'pdfdocument' : Structure of type 'pdfdocument'
Return value 'webdocument' : Structure of type 'webdocument'
Return value 'emailingdocument' : Structure of type 'emailingdocument'

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 'smsdocument'

This structure smsdocument was mentioned above. This structure has the following properties:

Property 'from' : string: The from address of the sms document.
Property 'message' : string: The message of the sms.
Property 'temporary' : boolean: Is this document set as a temporary document. The document will be removed when there are no
Property 'size' : int: Get the size of the document.
Property 'smartyVersion' : integer: What smarty version is used to render this document
Property 'id' : int: The ID of the document.
Property 'templateID' : int: The template ID of the document
Property 'name' : string: The name of the document.
Property 'description' : string: The description of the document.
Property 'archived' : boolean: Is this an archived document?.
Property 'created' : timestamp: The date and time when the document was created.
Property 'modified' : timestamp: The date and time when the document was last modified.
Property 'language' : string: The language of the document.
Property 'timezone' : string: Get the time zone of the document. If the timezone is not set, it returns

Structure 'pdfdocument'

This structure pdfdocument was mentioned above. This structure has the following properties:

Property 'status' : string: Status of the document.
Property 'pagecount' : int: The number of pages in the document.
Property 'size' : int: The size of the document.
Property 'faxheader' : string: The headerline above the fax.
Property 'temporary' : boolean: Is this document set as a temporary document. The document will be removed when there are no
Property 'id' : int: The ID of the document.
Property 'templateID' : int: The template ID of the document
Property 'name' : string: The name of the document.
Property 'description' : string: The description of the document.
Property 'archived' : boolean: Is this an archived document?.
Property 'created' : timestamp: The date and time when the document was created.
Property 'modified' : timestamp: The date and time when the document was last modified.
Property 'language' : string: The language of the document.
Property 'timezone' : string: Get the time zone of the document. If the timezone is not set, it returns

Structure 'webdocument'

This structure webdocument was mentioned above. This structure has the following properties:

Property 'loginrequired' : boolean: The page is only available for logged in profiles or subprofiles.
Property 'enabled' : boolean: Page enabled.
Property 'charset' : string: Gets the charset that should be used when showing/sending this document
Property 'htmlEscaping' : string: Check if the document is escaping HTML code
Property 'smartyVersion' : integer: What smarty version is used to render this document
Property 'id' : int: The ID of the document.
Property 'templateID' : int: The template ID of the document
Property 'name' : string: The name of the document.
Property 'description' : string: The description of the document.
Property 'archived' : boolean: Is this an archived document?.
Property 'created' : timestamp: The date and time when the document was created.
Property 'modified' : timestamp: The date and time when the document was last modified.
Property 'language' : string: The language of the document.
Property 'timezone' : string: Get the time zone of the document. If the timezone is not set, it returns

Structure 'emailingdocument'

This structure emailingdocument was mentioned above. This structure has the following properties:

Property 'convertedid' : int: The converted ID.
Property 'headers' : string: The additional headers.
Property 'subject' : string: The subject of the emailingdocument.
Property 'fromaddress' : EmailAddress: The fromaddress of the emailingdocument.
Property 'fromaddressstatus' : string: Get the status of the from address. When a from address is okay to do
Property 'bccaddress' : EmailAddress: The bccaddress of this emailingdocument.
Property 'replytoaddress' : EmailAddress: The reply-to address of the emailingdocument.
Property 'textversion' : string: The textversion of the emailingdocument.
Property 'useinlinestyles' : string: Should stylesheets in the document be merged into inline styles? This is usefull
Property 'temporary' : boolean: Is this document set as a temporary document. The document will be removed when there are no
Property 'priority_indicator' : string: Getting the priority header for emails who use this document
Property 'unsubscribe_header' : string: Should the list-unsubscribe header be sent with the mailing.
Property 'charset' : string: Gets the charset that should be used when showing/sending this document
Property 'htmlEscaping' : string: Check if the document is escaping HTML code
Property 'smartyVersion' : integer: What smarty version is used to render this document
Property 'id' : int: The ID of the document.
Property 'templateID' : int: The template ID of the document
Property 'name' : string: The name of the document.
Property 'description' : string: The description of the document.
Property 'archived' : boolean: Is this an archived document?.
Property 'created' : timestamp: The date and time when the document was created.
Property 'modified' : timestamp: The date and time when the document was last modified.
Property 'language' : string: The language of the document.
Property 'timezone' : string: Get the time zone of the document. If the timezone is not set, it returns

SOAP API method ScheduledFaxMailing_document