SOAP API method EmailingDocument_createEmailing

Back to API references

Description
This method will sent the emailing.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'profile' : int
ID of the profile
Parameter 'subprofile' : int
ID of the subprofile
Parameter 'database' : int
ID of the database
Parameter 'view' : int
ID of the view
Parameter 'collection' : int
ID of the collection
Parameter 'miniview' : int
ID of the miniview
Parameter 'emailingsettings' : Structure of type 'emailingsettings'
The settings of the mailing
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'processedemailing' : Structure of type 'processedemailing'
Return value 'scheduledemailing' : Structure of type 'scheduledemailing'

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.

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 'processedemailing'
This structure processedemailing was mentioned above. This structure has the following properties:
Property 'embedded' : boolean
Are the images embeded?
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 'followupsenabled' : boolean
Are the followups still activated?.
Property 'clickcount' : int
The total number of clicks.
Property 'impressioncount' : int
The total number of impressions.
Property 'errorcount' : int
The total number of errors.
Property 'abusecount' : int
The total number of abuses that were registered
Property 'destinationcount' : int
The total number of destinations.
Property 'emailingtype' : string
Get the emailing type
Property 'id' : int
Get the ID of the mailing.
Property 'timestamp' : timestamp
The timestamp when the mailing was sent.
Property 'description' : string
The description of the mailing.
Property 'personalized' : boolean
Was this mailing personalized?.
Property 'nodoubles' : boolean
Should the mailing be send to double mailaddresses?.
Property 'individual' : boolean
Was this mailing sent to an individual?.
Property 'test' : boolean
Was this mailing a test?
Property 'type' : string
The type of the mailing.
Property 'messagesperminute' : int
The max number of messages that are sent withing one minute
Property 'archived' : boolean
The mailing is archived.
Property 'priority' : int
Priority of the mailing. Higher value indicates higher priority.

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.