Documentation

Mailing.php

APIv3 functions for registering/processing mailing events.

Table of Contents

Functions

civicrm_api3_mailing_create()  : array<string|int, mixed>
Handle a create event.
civicrm_api3_mailing_gettokens()  : array<string|int, mixed>
Get tokens for one or more entity type
_civicrm_api3_mailing_gettokens_spec()  : mixed
Adjust Metadata for Create action.
_civicrm_api3_mailing_create_spec()  : mixed
Adjust Metadata for Create action.
_civicrm_api3_mailing_clone_spec()  : mixed
Adjust metadata for clone spec action.
civicrm_api3_mailing_clone()  : array<string|int, mixed>
Clone mailing.
civicrm_api3_mailing_delete()  : array<string|int, mixed>
Handle a delete event.
civicrm_api3_mailing_get()  : array<string|int, mixed>
Handle a get event.
_civicrm_api3_mailing_get_formatResult()  : array<string|int, mixed>
Format definition.
_civicrm_api3_mailing_submit_spec()  : mixed
Adjust metadata for mailing submit api function.
civicrm_api3_mailing_submit()  : array<string|int, mixed>
Mailing submit.
civicrm_api3_mailing_event_bounce()  : array<string|int, mixed>
Process a bounce event by passing through to the BAOs.
_civicrm_api3_mailing_event_bounce_spec()  : mixed
Adjust Metadata for bounce_spec action.
civicrm_api3_mailing_event_confirm()  : array<string|int, mixed>
Handle a confirm event.
_civicrm_api3_mailing_deprecation()  : array<string|int, mixed>
Declare deprecated functions.
civicrm_api3_mailing_event_reply()  : array<string|int, mixed>
Handle a reply event.
_civicrm_api3_mailing_event_reply_spec()  : mixed
Adjust Metadata for event_reply action.
civicrm_api3_mailing_event_forward()  : array<string|int, mixed>
Handle a forward event.
_civicrm_api3_mailing_event_forward_spec()  : mixed
Adjust Metadata for event_forward action.
civicrm_api3_mailing_event_click()  : array<string|int, mixed>
Handle a click event.
civicrm_api3_mailing_event_open()  : array<string|int, mixed>
Handle an open event.
civicrm_api3_mailing_preview()  : mixed
Preview mailing.
_civicrm_api3_mailing_send_test_spec()  : mixed
Adjust metadata for send test function.
civicrm_api3_mailing_send_test()  : array<string|int, mixed>
Send test mailing.
_civicrm_api3_mailing_stats_spec()  : mixed
Adjust Metadata for send_mail action.
civicrm_api3_mailing_stats()  : array<string|int, mixed>
Function which needs to be explained.
_civicrm_api3_mailing_update_email_resetdate_spec()  : mixed
civicrm_api3_mailing_update_email_resetdate()  : array<string|int, mixed>
Fix the reset dates on the email record based on when a mail was last delivered.

Functions

civicrm_api3_mailing_create()

Handle a create event.

civicrm_api3_mailing_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
throws
UnauthorizedException
Return values
array<string|int, mixed> —

API Success Array

civicrm_api3_mailing_gettokens()

Get tokens for one or more entity type

civicrm_api3_mailing_gettokens(array<string|int, mixed> $params) : array<string|int, mixed>

Output will be formatted either as a flat list, or pass sequential=1 to retrieve as a hierarchy formatted for select2.

Parameters
$params : array<string|int, mixed>

Should contain an array of entities to retrieve tokens for.

Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_mailing_gettokens_spec()

Adjust Metadata for Create action.

_civicrm_api3_mailing_gettokens_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

_civicrm_api3_mailing_create_spec()

Adjust Metadata for Create action.

_civicrm_api3_mailing_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

_civicrm_api3_mailing_clone_spec()

Adjust metadata for clone spec action.

_civicrm_api3_mailing_clone_spec(array<string|int, mixed> &$spec) : mixed
Parameters
$spec : array<string|int, mixed>

civicrm_api3_mailing_clone()

Clone mailing.

civicrm_api3_mailing_clone(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

civicrm_api3_mailing_delete()

Handle a delete event.

civicrm_api3_mailing_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed> —

API Success Array

civicrm_api3_mailing_get()

Handle a get event.

civicrm_api3_mailing_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_mailing_get_formatResult()

Format definition.

_civicrm_api3_mailing_get_formatResult(array<string|int, mixed> $result) : array<string|int, mixed>
Parameters
$result : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_mailing_submit_spec()

Adjust metadata for mailing submit api function.

_civicrm_api3_mailing_submit_spec(array<string|int, mixed> &$spec) : mixed
Parameters
$spec : array<string|int, mixed>

civicrm_api3_mailing_submit()

Mailing submit.

civicrm_api3_mailing_submit(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

civicrm_api3_mailing_event_bounce()

Process a bounce event by passing through to the BAOs.

civicrm_api3_mailing_event_bounce(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_mailing_event_bounce_spec()

Adjust Metadata for bounce_spec action.

_civicrm_api3_mailing_event_bounce_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_mailing_event_confirm()

Handle a confirm event.

civicrm_api3_mailing_event_confirm(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_mailing_deprecation()

Declare deprecated functions.

api notice

_civicrm_api3_mailing_deprecation() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array of deprecated actions

civicrm_api3_mailing_event_reply()

Handle a reply event.

civicrm_api3_mailing_event_reply(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_mailing_event_reply_spec()

Adjust Metadata for event_reply action.

_civicrm_api3_mailing_event_reply_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_mailing_event_forward()

Handle a forward event.

it is highly unlikely this function is ever used because to use it someone needs to forward an email by clicking on a link rather than.. forwarding the email. Even the links are probably never generated.

Also - it would be poor email server reputation management. Function is nasty but can die with apiv4 whenever that is (along with surveyRespondant)

civicrm_api3_mailing_event_forward(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_mailing_event_forward_spec()

Adjust Metadata for event_forward action.

_civicrm_api3_mailing_event_forward_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_mailing_event_click()

Handle a click event.

civicrm_api3_mailing_event_click(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

civicrm_api3_mailing_event_open()

Handle an open event.

civicrm_api3_mailing_event_open(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

civicrm_api3_mailing_preview()

Preview mailing.

civicrm_api3_mailing_preview(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

Array per getfields metadata.

Tags
throws
CRM_Core_Exception

_civicrm_api3_mailing_send_test_spec()

Adjust metadata for send test function.

_civicrm_api3_mailing_send_test_spec(array<string|int, mixed> &$spec) : mixed
Parameters
$spec : array<string|int, mixed>

civicrm_api3_mailing_send_test()

Send test mailing.

civicrm_api3_mailing_send_test(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_mailing_stats_spec()

Adjust Metadata for send_mail action.

_civicrm_api3_mailing_stats_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_mailing_stats()

Function which needs to be explained.

civicrm_api3_mailing_stats(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_mailing_update_email_resetdate_spec()

_civicrm_api3_mailing_update_email_resetdate_spec(mixed &$spec) : mixed
Parameters
$spec : mixed

civicrm_api3_mailing_update_email_resetdate()

Fix the reset dates on the email record based on when a mail was last delivered.

civicrm_api3_mailing_update_email_resetdate(array<string|int, mixed> $params) : array<string|int, mixed>

We only consider mailings that were completed and finished in the last 3 to 7 days Both the min and max days can be set via the params

Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results