API Documentation
Table of Contents
Namespaces
Constants
- COOKIE_SESSION : mixed = \true
- MAIL_BULK_DEFAULT_LIMIT : mixed = 200
- MAIL_BULK_MAX_RECIPIENTS : mixed = 200
- PDO_WILL_CATCH : mixed = true
- SANITY_DB_ALLOW_NO_TABLES : mixed = \true
- SANITY_DB_ALLOW_NO_TABLES : mixed = \true
Functions
- proxySmallJsonResolveIps() : mixed
- proxySmallJsonValidateUrl() : mixed
- bulk_mail_cli_shell_quote() : mixed
- Shell-escape a value for single-quoted CLI args.
- bulk_mail_cli_instructions() : string
- Build equivalent scripts/send-bulk-mail.php instructions for the current form values.
- showDynamicConfig() : mixed
- mail_admin_nav() : mixed
- Shared top links for Admin → Mail pages (and testmail).
- org_manager_url() : string
- org_manager_tenants() : array<int, array<string, mixed>>
- org_manager_find_tenant() : array<string, mixed>|null
- org_manager_tenant_label() : string
- org_manager_indent() : string
- org_manager_parent_choices() : array<int, array<string, mixed>>
- Parents this org may move under: the same tenant, excluding itself and its descendants.
- org_manager_blocked() : string
- org_manager_count() : string
- org_manager_join() : string
- org_manager_courses() : array<int, array<string, mixed>>
- Courses in this tenant, including where they are placed.
- org_manager_post() : void
- org_manager_posted_parent() : int|null
- org_manager_posted_type() : string|null
- org_manager_require_course() : void
- org_manager_require_in_tenant() : void
- Refuse an organization id that is not in the tenant currently open.
- admin_profile_pretty_json() : mixed
- admin_profile_cell() : mixed
- redirect() : mixed
- response() : mixed
Constants
COOKIE_SESSION
public
mixed
COOKIE_SESSION
= \true
MAIL_BULK_DEFAULT_LIMIT
public
mixed
MAIL_BULK_DEFAULT_LIMIT
= 200
MAIL_BULK_MAX_RECIPIENTS
public
mixed
MAIL_BULK_MAX_RECIPIENTS
= 200
PDO_WILL_CATCH
public
mixed
PDO_WILL_CATCH
= true
SANITY_DB_ALLOW_NO_TABLES
public
mixed
SANITY_DB_ALLOW_NO_TABLES
= \true
SANITY_DB_ALLOW_NO_TABLES
public
mixed
SANITY_DB_ALLOW_NO_TABLES
= \true
Functions
proxySmallJsonResolveIps()
proxySmallJsonResolveIps(mixed $host) : mixed
Parameters
- $host : mixed
proxySmallJsonValidateUrl()
proxySmallJsonValidateUrl(mixed $proxyUrl) : mixed
Parameters
- $proxyUrl : mixed
bulk_mail_cli_shell_quote()
Shell-escape a value for single-quoted CLI args.
bulk_mail_cli_shell_quote(mixed $value) : mixed
Parameters
- $value : mixed
bulk_mail_cli_instructions()
Build equivalent scripts/send-bulk-mail.php instructions for the current form values.
bulk_mail_cli_instructions(mixed $context_id, mixed $from_user_id, mixed $subject, mixed $body, mixed $single_email, mixed $days, mixed $exclude_recent_bulk_days, mixed $limit, mixed $include_opted_out, mixed $premium_only) : string
Includes --rate=5 as a batch-mode tip (UI send does not pace).
Parameters
- $context_id : mixed
- $from_user_id : mixed
- $subject : mixed
- $body : mixed
- $single_email : mixed
- $days : mixed
- $exclude_recent_bulk_days : mixed
- $limit : mixed
- $include_opted_out : mixed
- $premium_only : mixed
Return values
string —Multi-line text for a copyable textarea
showDynamicConfig()
showDynamicConfig(mixed $url) : mixed
Parameters
- $url : mixed
mail_admin_nav()
Shared top links for Admin → Mail pages (and testmail).
mail_admin_nav([string $active = 'home' ]) : mixed
Parameters
- $active : string = 'home'
-
One of: home, test, bulk, suppress, events, sent
org_manager_url()
org_manager_url(int $keyId[, mixed $orgId = 0 ]) : string
Parameters
- $keyId : int
- $orgId : mixed = 0
Return values
stringorg_manager_tenants()
org_manager_tenants() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>org_manager_find_tenant()
org_manager_find_tenant(array<int, array<string, mixed>> $tenants, int $keyId) : array<string, mixed>|null
Parameters
- $tenants : array<int, array<string, mixed>>
- $keyId : int
Return values
array<string, mixed>|nullorg_manager_tenant_label()
org_manager_tenant_label(array<string, mixed> $row) : string
Parameters
- $row : array<string, mixed>
Return values
stringorg_manager_indent()
org_manager_indent(array<string, mixed> $org) : string
Parameters
- $org : array<string, mixed>
Return values
stringorg_manager_parent_choices()
Parents this org may move under: the same tenant, excluding itself and its descendants.
org_manager_parent_choices(array<int, array<string, mixed>> $orgs, int $orgId) : array<int, array<string, mixed>>
Parameters
- $orgs : array<int, array<string, mixed>>
- $orgId : int
Return values
array<int, array<string, mixed>>org_manager_blocked()
org_manager_blocked(array<string, mixed> $holdings) : string
Parameters
- $holdings : array<string, mixed>
Return values
string —empty when the org may be deleted
org_manager_count()
org_manager_count(int $n, string $one, string $many) : string
Parameters
- $n : int
- $one : string
- $many : string
Return values
stringorg_manager_join()
org_manager_join(array<string|int, string> $parts) : string
Parameters
- $parts : array<string|int, string>
Return values
stringorg_manager_courses()
Courses in this tenant, including where they are placed.
org_manager_courses(int $keyId) : array<int, array<string, mixed>>
Parameters
- $keyId : int
Return values
array<int, array<string, mixed>>org_manager_post()
org_manager_post(int $keyId) : void
Parameters
- $keyId : int
org_manager_posted_parent()
org_manager_posted_parent() : int|null
Return values
int|nullorg_manager_posted_type()
org_manager_posted_type() : string|null
Return values
string|nullorg_manager_require_course()
org_manager_require_course(int $keyId, int $contextId) : void
Parameters
- $keyId : int
- $contextId : int
org_manager_require_in_tenant()
Refuse an organization id that is not in the tenant currently open.
org_manager_require_in_tenant(int $keyId, int|null $orgId) : void
A null parent is the tenant root and is allowed.
Parameters
- $keyId : int
- $orgId : int|null
admin_profile_pretty_json()
admin_profile_pretty_json(mixed $raw) : mixed
Parameters
- $raw : mixed
admin_profile_cell()
admin_profile_cell(mixed $value) : mixed
Parameters
- $value : mixed
redirect()
redirect([mixed $to = null ][, mixed $status = 302 ][, mixed $headers = [] ]) : mixed
Parameters
- $to : mixed = null
- $status : mixed = 302
- $headers : mixed = []
response()
response([mixed $content = '' ][, mixed $status = 200 ][, array<string|int, mixed> $headers = [] ]) : mixed
Parameters
- $content : mixed = ''
- $status : mixed = 200
- $headers : array<string|int, mixed> = []