Transactional

This service is for sending Transactional Emails and listing data created by both API and SMTP sends.

send

string transactional.send( string toAddress, string fromAddress, string fromAlias, string subject, string htmlContent, string textContent, array options )

Send a Transactional Email

Parameters

toAddress

Email recipient address, eg. recipient@example.com

fromAddress

Email from address, eg. newsletters@oxfordstones.com

fromAlias

Email from name, eg. Oxford Stones

subject

Email subject line

htmlContent

HTML content. Send an empty string if not required.

textContent

Text content. Send an empty string if not required.

options

Additional configuration options for the send, as an associative array.

Name

Type

Description

tags

array | string

Tag the email send, to later filter in reports. Indexed array of strings, or comma-separated list of strings.

messageId

string

Globally unique Message-Id header to use in the email. This will also be made available in reporting.

trackOpens

boolean

Override the default option for whether to track opens

trackClicks

boolean

Override the default option for whether to track clicks

checkUnsubs

boolean

Override the default option for whether to check the recipient against the Master Unsubscribe List

ignoreBouncesbooleanOverride the default option for whether to ignore the Master Bounce List

Return Values

Returns the unique identifier for this Transactional Email send, as a string. This string will be included in any Transactional reports.


getFromAddresses

array transactional.getFromAddresses( void )

Requests a list of fromAddresses that have been used in Transactional Emails.

Return Values

Returns an array of associative arrays of fromAddress data. The elements are as follows:

Name

Type

Description

address_id

int

Unique identifier for this fromAddress

email_address

string

Email Address for this fromAddress


getTags

array transactional.getTags( void )

Requests the details of the single comparison report requested.

Return Values

Returns an indexed array of tags.



Service

transactional

Methods