SOAP API method Account_createEmailing

Description
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'

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

Structure 'splitrunsettings'
This structure splitrunsettings was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition
Property 'testgroups' : SplitRunTestGroupArray
Get the testgroups

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.

Stay up to date

Receive our monthly top tips, the latest news about database marketing, email marketing, mobile and much more!

Try Copernica yourself!

  • Sign up in less than 30 seconds

  • Access to every feature

  • No upfront payment required

Try Copernica for free