SOAP API method ScheduledSmsMailing_settings

Back to API references

Description
Get the settings object that is filled in with all the settings of this mailing. The settings object returned is not necesarily the same as the settings object that was used to create the mailing.

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

Return values
Return value 'smsmailingsettings' : Structure of type 'smsmailingsettings'
Return value 'faxmailingsettings' : Structure of type 'faxmailingsettings'
Return value 'emailingsettings' : Structure of type 'emailingsettings'

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 'smsmailingsettings'
This structure smsmailingsettings was mentioned above. This structure has the following properties:
Property 'registerstatus' : boolean
The errors are being registered
Property 'type' : string
The type of sms message
Property 'starttime' : timestamp
The starttime of the mailing.
Property 'dateinterval' : DateInterval
The interval for the mailing.
Property 'iterations' : int
The iterations of the settings.
Property 'description' : string
The description of the mailing.
Property 'processedmissediterations' : boolean
The processed missed iterations.
Property 'personalized' : boolean
Should the mailing be personalized?.
Property 'test' : boolean
Is this a test mailing?.
Property 'nodoubles' : boolean
Should the double addresses be skipped?.
Property 'messagesperminute' : int
The max number of messages that are sent withing one minute
Property 'isscheduled' : boolean
Is the mailing a scheduled mailing?.
Property 'extradocumentproperties' : Map
Get the extra document properties of this mailing. This doen't contain the
Property 'priority' : int
The priority settings of the mailing.

Structure 'faxmailingsettings'
This structure faxmailingsettings was mentioned above. This structure has the following properties:
Property 'registerstatus' : boolean
Get if the status should be registered for the mailing?
Property 'starttime' : timestamp
The starttime of the mailing.
Property 'dateinterval' : DateInterval
The interval for the mailing.
Property 'iterations' : int
The iterations of the settings.
Property 'description' : string
The description of the mailing.
Property 'processedmissediterations' : boolean
The processed missed iterations.
Property 'personalized' : boolean
Should the mailing be personalized?.
Property 'test' : boolean
Is this a test mailing?.
Property 'nodoubles' : boolean
Should the double addresses be skipped?.
Property 'messagesperminute' : int
The max number of messages that are sent withing one minute
Property 'isscheduled' : boolean
Is the mailing a scheduled mailing?.
Property 'extradocumentproperties' : Map
Get the extra document properties of this mailing. This doen't contain the
Property 'priority' : int
The priority settings of the mailing.

Structure 'emailingsettings'
This structure emailingsettings was mentioned above. This structure has the following properties:
Property 'contenttype' : string
The contenttype of the emailingsettings.
Property 'embeddedimages' : boolean
Should the images be embedded?.
Property 'messagesperminute' : int
Update the max number of messages per minute
Property 'cacheexternalimages' : boolean
Should the external images be cached?
Property 'registerimpressions' : boolean
Should the impressions be registered?.
Property 'registerclicks' : string
Should the clicks be registered?.
Property 'registererrors' : boolean
Should the errors be registered?.
Property 'registerabuses' : boolean
Should the abuses be registered?.
Property 'starttime' : timestamp
The starttime of the mailing.
Property 'dateinterval' : DateInterval
The interval for the mailing.
Property 'iterations' : int
The iterations of the settings.
Property 'description' : string
The description of the mailing.
Property 'processedmissediterations' : boolean
The processed missed iterations.
Property 'personalized' : boolean
Should the mailing be personalized?.
Property 'test' : boolean
Is this a test mailing?.
Property 'nodoubles' : boolean
Should the double addresses be skipped?.
Property 'isscheduled' : boolean
Is the mailing a scheduled mailing?.
Property 'extradocumentproperties' : Map
Get the extra document properties of this mailing. This doen't contain the
Property 'priority' : int
The priority settings of the mailing.