SOAP API method ProcessedEmailing_scheduledMailing

Back to API references

Description
If this mailing was created as a result of a scheduled mailing, this method returns the scheduled mailing object that it was created from

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 'scheduledfaxmailing' : Structure of type 'scheduledfaxmailing'
Return value 'scheduledemailing' : Structure of type 'scheduledemailing'
Return value 'scheduledsmsmailing' : Structure of type 'scheduledsmsmailing'

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 'scheduledfaxmailing'
This structure scheduledfaxmailing was mentioned above. This structure has the following properties:
Property 'registerstatus' : boolean
Will the status be registered?.
Property 'description' : string
The description of the scheduled mailing
Property 'test' : boolean
Was this a test mailing?.
Property 'personalized' : boolean
Was this mailing personalized?.
Property 'nodoubles' : boolean
Was the target contains doubles?.
Property 'messagesperminute' : int
The max number of messages that are sent withing one minute
Property 'priority' : int
Priority of the mailing. Higher value indicated higher priority.
Property 'nextstarttime' : timestamp
The next time when this scheduled event will run.
Property 'schedulediterations' : int
The number of iterations that are still remaining.
Property 'processediterations' : int
The number of iterations that were already processed.
Property 'previousstarttime' : string
The starttime of the last iteration.
Property 'processmissediterations' : boolean
Will the missed iterations be processed anyway?.
Property 'id' : int
The ID of the scheduledevent.

Structure 'scheduledemailing'
This structure scheduledemailing was mentioned above. This structure has the following properties:
Property 'embedded' : boolean
Are the external images cached?
Property 'contenttype' : string
The contenttype of the mailing.
Property 'registerclicks' : string
Will the clicks be registered?.
Property 'registerimpressions' : boolean
Will the impressions be registered?.
Property 'registererrors' : boolean
Will the errors be registered?.
Property 'registerabuses' : boolean
Will the abuses be registered?.
Property 'condition' : string
Get the condition
Property 'emailingtype' : string
Get the emailing type
Property 'description' : string
The description of the scheduled mailing
Property 'test' : boolean
Was this a test mailing?.
Property 'personalized' : boolean
Was this mailing personalized?.
Property 'nodoubles' : boolean
Was the target contains doubles?.
Property 'messagesperminute' : int
The max number of messages that are sent withing one minute
Property 'priority' : int
Priority of the mailing. Higher value indicated higher priority.
Property 'nextstarttime' : timestamp
The next time when this scheduled event will run.
Property 'schedulediterations' : int
The number of iterations that are still remaining.
Property 'processediterations' : int
The number of iterations that were already processed.
Property 'previousstarttime' : string
The starttime of the last iteration.
Property 'processmissediterations' : boolean
Will the missed iterations be processed anyway?.
Property 'id' : int
The ID of the scheduledevent.

Structure 'scheduledsmsmailing'
This structure scheduledsmsmailing was mentioned above. This structure has the following properties:
Property 'registerstatus' : boolean
Will the status be registered?.
Property 'description' : string
The description of the scheduled mailing
Property 'test' : boolean
Was this a test mailing?.
Property 'personalized' : boolean
Was this mailing personalized?.
Property 'nodoubles' : boolean
Was the target contains doubles?.
Property 'messagesperminute' : int
The max number of messages that are sent withing one minute
Property 'priority' : int
Priority of the mailing. Higher value indicated higher priority.
Property 'nextstarttime' : timestamp
The next time when this scheduled event will run.
Property 'schedulediterations' : int
The number of iterations that are still remaining.
Property 'processediterations' : int
The number of iterations that were already processed.
Property 'previousstarttime' : string
The starttime of the last iteration.
Property 'processmissediterations' : boolean
Will the missed iterations be processed anyway?.
Property 'id' : int
The ID of the scheduledevent.