API reference: Message management

 API reference: Message management documents the function signatures, parameters, return values, and error behavior of the Elaine HTTP API.

Note

Function availability depends on the Elaine release and enabled features. Authenticate HTTP requests with an Elaine-issued Bearer JWT.

Functions

api_addressToGroupOrSegment

boolean|integer api_addressToGroupOrSegment( int $nl_id , int $group_id , int $segment_id , string $status = 'ready' , bool $c_id = false )

Addresses a mailing to a group or target group depending on whether the $group_id or $segment_id has been included.

Parameters

Return Value

api_createMailingFromTemplate

integer api_createMailingFromTemplate( int $template_id , string $nl_name , string $nl_title = '' , int $folder_id )

Parameters

Return Value

api_getActionmails

array|integer api_getActionmails( string $nl_title = '' )

• 'nl_id': ID
• 'nl_name': name
• 'nl_title': code
• 'is_transactionmail': transactional email yes/no
• 'MailingType': 'mobile', 'mailing'

Parameters

Return Value

api_getGroupLastMailing

integer api_getGroupLastMailing( int $ev_id )

Returns the ID of the mailing last sent to the recipient group $ev_id.

Parameters

Return Value

api_getMailingContent

string|integer api_getMailingContent( int $nl_id )

Parameters

Return Value

api_getMailingsByStatus

array|integer api_getMailingsByStatus( string $status = '' )

Delivers an array of all mailings, which are currently in the specified status ($status='': all). The return is an array of the data sets of each mailing, containing e.g. start and end time, number of emails, abort reasons and number of recipients. Possible variants of the email status: 'on_hold', 'actionmail', 'ready', 'clearing', 'not_started', 'finished', 'processing', 'paused', 'aborted', 'failed', 'queued', 'scheduled', 'pending', 'sampling', 'deleted'

Parameters

Return Value

api_getMessageInfo

array|integer api_getMessageInfo( string $message_name = '' , string $message_status = '' )

Delivers an array of all messages, which are currently in the [optional] specified $message_status or having the [optional] specified $message_name. The return is an array of the data sets of each message, containing name, identifier und status. Possible variants of the email status: 'on_hold', 'actionmail', 'ready', 'clearing', 'not_started', 'finished', 'processing', 'paused', 'aborted', 'failed', 'queued', 'scheduled', 'pending', 'sampling', 'deleted'

Parameters

Return Value

api_mailingAddressToGroup

boolean|integer api_mailingAddressToGroup( int $nl_id , int $group_id , string $type = 'ready' , bool $c_id = false )

Addresses the mailing with the $nl_id to the group $group_id. The parameter $type defines the clearing type. Possible values are:

• 'ready': without clearing.
• 'not_startet': clearing allowed.
• 'clearing': Requests clearing.

The $c_id specifies the campaign ID.

Parameters

Return Value

api_mailingAddressToSegment

boolean|integer api_mailingAddressToSegment( int $nl_id , int $segment_id , string $type = 'ready' , bool $c_id = false )

Addresses the mailing with the $nl_id to the target group with the $segment_id. The other parameters perform the same as in the function api_mailingAddressToGroup().

Parameters

Return Value

api_mailingCopy

integer api_mailingCopy( int $nl_id , string $new_nl_name = '' , string $new_nl_title = '' , int $new_folder_id )

Parameters

Return Value

api_mailingDelete

integer|boolean api_mailingDelete( int $nl_id )

Parameters

Return Value

api_mailingPause

boolean api_mailingPause( int $nl_id , bool $release = false )

Pauses the sending process of the specified mailing or deactivates the pause.

Parameters

Return Value

api_mailingRelease

boolean api_mailingRelease( int $nl_id , string $datetime = null , string $cycle = 'no' )

Starts the sending of the specified mailing. If no time (format 'YYYY-MM-DD HH:MM:SS') is given, the sending process will be started immediately. As mailings are always sent by means of the schedule mechanism, there may be a delay of a few minutes between the call-up of the function and the actual send start. The parameter $cycle can set up a cyclical sending process. Possible values are: 'no', 'day', 'week', 'month', 'year'

Parameters

Return Value

api_mailingRender

array|boolean api_mailingRender( int $elaine_id , int $mailing_id , array $userdata = array() , int $group , bool $preview = false )

Returns an associative array of a mailing (keys 'header' and 'body'). The data from the mailing $mailing_id will be processed for the recipient profile specified as $elaine_id.

Parameters

Return Value

api_mailingStop

void api_mailingStop( int $nl_id )

Aborts the sending of the specified mailing.

Parameters

Return Value

api_mailingTestsend

boolean api_mailingTestsend( int $nl_id , int $ev_id )

Runs a test sending for the specified mailing. The $ev_id shows the ID of the group, to whose approval list the mailing is to be sent. Default is the addressed group.

Parameters

Return Value

api_mailingUnrelease

boolean api_mailingUnrelease( int $mailingID )

Parameters

Return Value

api_sendSingle

boolean|integer api_sendSingle( int $nl_id , int $p_id , int $ev_id , int $priority = null , int $variant_position = null , string $type = 'normal' )

Sends the mailing with the ID $nl_id to the recipient with the profile ID $elaine_id with the sender data of the group $ev_id. Recipients on the Bounce- or Blacklist are excluded from dispatch.

Behavior in bulk mode: The bulk parameter $abort_on_error has no use for this function. The transferred block is either entirely processed or completely discarded. The bundled transmitted single calls must reference to the same $nl_id.

Parameters

Return Value

api_userSendMail

boolean|integer api_userSendMail( int $mailing_id , int $user_id , int $group , bool $bcc = false , bool $preview = false )

Deprecated since 6.6.1 - Please do not use this function anymore. This function will be disabled in a future version. Instead, use the function api_sendSingle().
Sends the mailing referenced via $mailing_id to the recipient with the profile ID $user_id. For link personalisation, you can optionally enter a recipient group ID; the mailing will then be generated for the recipient as group member. Optionally, you can transfer an additional recipient as string. If $preview is set to true, this email will be sent as preview email.

Parameters

Return Value

Related topics

 
• API reference
 
• Call the HTTP API with cURL
 
• Authentication, network security, and VPN