MailingAB.php
APIv3 functions for registering/processing mailing ab testing events.
Table of Contents
Functions
- _civicrm_api3_mailing_a_b_create_spec() : mixed
- civicrm_api3_mailing_a_b_create() : array<string|int, mixed>
- Handle a create mailing ab testing.
- civicrm_api3_mailing_a_b_delete() : array<string|int, mixed>
- Handle a delete event.
- civicrm_api3_mailing_a_b_get() : array<string|int, mixed>
- Handle a get event.
- _civicrm_api3_mailing_a_b_submit_spec() : mixed
- Adjust Metadata for submit action.
- civicrm_api3_mailing_a_b_submit() : array<string|int, mixed>
- Send A/B mail to A/B recipients respectively.
- _civicrm_api3_mailing_a_b_fill_winner() : mixed
- _civicrm_api3_mailing_a_b_graph_stats_spec() : mixed
- Adjust Metadata for graph_stats action.
- civicrm_api3_mailing_a_b_graph_stats() : array<string|int, mixed>
- Send graph detail for A/B tests mail.
Functions
_civicrm_api3_mailing_a_b_create_spec()
_civicrm_api3_mailing_a_b_create_spec(array<string|int, mixed> &$spec) : mixed
Parameters
- $spec : array<string|int, mixed>
civicrm_api3_mailing_a_b_create()
Handle a create mailing ab testing.
civicrm_api3_mailing_a_b_create(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_a_b_delete()
Handle a delete event.
civicrm_api3_mailing_a_b_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_a_b_get()
Handle a get event.
civicrm_api3_mailing_a_b_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_a_b_submit_spec()
Adjust Metadata for submit action.
_civicrm_api3_mailing_a_b_submit_spec(array<string|int, mixed> &$spec) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $spec : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_mailing_a_b_submit()
Send A/B mail to A/B recipients respectively.
civicrm_api3_mailing_a_b_submit(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_mailing_a_b_fill_winner()
_civicrm_api3_mailing_a_b_fill_winner(int $winner_id, int $final_id) : mixed
Parameters
- $winner_id : int
-
The experimental mailing chosen as the "winner".
- $final_id : int
-
The final mailing which should imitate the "winner".
Tags
_civicrm_api3_mailing_a_b_graph_stats_spec()
Adjust Metadata for graph_stats action.
_civicrm_api3_mailing_a_b_graph_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_a_b_graph_stats()
Send graph detail for A/B tests mail.
civicrm_api3_mailing_a_b_graph_stats(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>