SOAP API methode Account_createEmailing

Terug naar de indexpagina

Beschrijving
This method can be used to create processedEmailings (mailings that are sent right away) and scheduled e-mailings (mailings that are scheduled to be sent later). It is also possible to use this method for making splitrun mailings. A splitrun mailing has a number of testgroups and the final document that is sent is determined based on the results of the testgroups that were sent earlier.

Parameters
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 'emailingdocument' : Structure of type 'emailingdocument'
The document to send
Parameter 'splitrunsettings' : Structure of type 'splitrunsettings'
The settings for the splitrun emailing
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'

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

Structuur 'splitrunsettings'
De structuur 'splitrunsettings' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition
Eigenschap 'testgroups' : SplitRunTestGroupArray
Get the testgroups

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

Structuur 'login'
De structuur 'login' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'username' : string
The username of the login attempt
Eigenschap 'account' : string
The account name of the login attempt
Eigenschap 'password' : string
The password for the login attempt

Structuur 'processedemailing'
De structuur 'processedemailing' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'embedded' : boolean
Are the images embeded?
Eigenschap 'contenttype' : string
The contenttype of the mailing.
Eigenschap 'registerclicks' : string
Will the clicks be registered?.
Eigenschap 'registerimpressions' : boolean
Will the impressions be registered?.
Eigenschap 'registererrors' : boolean
Will the errors be registered?.
Eigenschap 'registerabuses' : boolean
Will the abuses be registered?.
Eigenschap 'followupsenabled' : boolean
Are the followups still activated?.
Eigenschap 'clickcount' : int
The total number of clicks.
Eigenschap 'impressioncount' : int
The total number of impressions.
Eigenschap 'errorcount' : int
The total number of errors.
Eigenschap 'abusecount' : int
The total number of abuses that were registered
Eigenschap 'destinationcount' : int
The total number of destinations.
Eigenschap 'emailingtype' : string
Get the emailing type
Eigenschap 'id' : int
Get the ID of the mailing.
Eigenschap 'timestamp' : timestamp
The timestamp when the mailing was sent.
Eigenschap 'description' : string
The description of the mailing.
Eigenschap 'personalized' : boolean
Was this mailing personalized?.
Eigenschap 'nodoubles' : boolean
Should the mailing be send to double mailaddresses?.
Eigenschap 'individual' : boolean
Was this mailing sent to an individual?.
Eigenschap 'test' : boolean
Was this mailing a test?
Eigenschap 'type' : string
The type of the mailing.
Eigenschap 'messagesperminute' : int
The max number of messages that are sent withing one minute
Eigenschap 'archived' : boolean
The mailing is archived.
Eigenschap 'priority' : int
Priority of the mailing. Higher value indicates higher priority.

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