Back to API references

SOAP API method ProcessedEmailing_settings

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. Properties like interval are not included, because they are not used by processed mailings.

Parameters

Name Type Description
id * int Unique identifier (id) of the object ProcessedEmailing. The method only applies to the processedemailing with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
faxmailingsettings Structure of type 'faxmailingsettings'
emailingsettings Structure of type 'emailingsettings'
smsmailingsettings Structure of type 'smsmailingsettings'

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

Structure 'faxmailingsettings'

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

Structure 'emailingsettings'

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

Structure 'smsmailingsettings'

Name Type Description
registerstatus boolean The errors are being registered
type string The type of sms message
starttime timestamp The starttime of the mailing.
dateinterval DateInterval The interval for the mailing.
iterations int The iterations of the settings.
description string The description of the mailing.
processedmissediterations boolean The processed missed iterations.
personalized boolean Should the mailing be personalized?.
test boolean Is this a test mailing?.
nodoubles boolean Should the double addresses be skipped?.
messagesperminute int The max number of messages that are sent withing one minute
isscheduled boolean Is the mailing a scheduled mailing?.
extradocumentproperties Map Get the extra document properties of this mailing. This doen't contain the
priority int The priority settings of the mailing.