Controller: /siteworx/email/dmarc
=================================
:Required Permissions: EMAIL, DNS
Action: ``add``
---------------
:Added in Version: 7.10.0-2034
:Description: Add a DMARC DNS Record.
Input Parameters
^^^^^^^^^^^^^^^^^
.. list-table::
:widths: auto
:header-rows: 1
* - Name
- Type
- Required?
- Example Values
- Default Values
- Notes
* - ``host``
- string
- No*
-
- example.com
-
* - ``zone_id``
- integer
- No*
-
-
-
* - ``record_id``
- string
- No
-
-
-
* - ``ttl``
- string
- No*
-
- 43200
- The TTL or Time To Live of a DNS record is a suggestion to other DNS servers of how long to cache the given DNS record. Short TTLs mean your DNS server will be queried more often and longer TTLs mean your DNS server will be queried less often.
If you are planning a change in DNS and need other DNS servers to find out about the change sooner rather than later, it is helpful to drop the TTL temporarily during this change.
* - ``p``
- string
- No*
- none, quarantine, reject
- none
- Policy (p): Policy for receiving messages. Determines the policy for receiving messages for the domain and subdomains. - None (p=none): no action is required.
- Quarantine (p=quarantine): the domain possessor asks that failed DMARC messages are considered suspicious. Thus the messages will end up in the spam folder, be flagged as dubious.
- Reject (p=reject): owner is requesting that messages failed by DMARC verification be rejected. The rejection must be done during an SMTP transaction.
* - ``sp``
- string
- No*
- none, quarantine, reject
- none
- Subdomain Policy (sp): This tag represents the requested handling policy for subdomains.
* - ``adkim``
- string
- No
- r, s
-
- DKIM Mode (adkim): DKIM record authentication check. It can take the value Relaxed “r”, or Strict “s”. - In relaxed mode, if the DKIM record being verified belongs to the domain d=example.com, and the message is sent from email@news.example.com, the verification will pass.
- In the strict mode, the check will be passed only if the sending comes from an address on the example.com domain. Subdomains will not pass validation.
* - ``aspf``
- string
- No
- r, s
-
- SPF Mode (aspf): SPF record authentication check. By analogy with adkim, it can be Relaxed “r”, or Strict “s”.
* - ``pct``
- integer
- No
- 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100
- 100
- Percentage (pct): It specifies the number of emails to be filtered, indicated as a percentage. For example, “pct = 20” will filter 20% of emails.
* - ``fo``
- string
- No
- 0, 1, d, s
-
- Report Format (fo): This pertains to how forensic reports are created and presented to DMARC users. - fo=0: Generate a DMARC failure report if all underlying authentication mechanisms (SPF and DKIM) fail to produce an aligned “pass” result.
- fo=1: Generate a DMARC failure report if any underlying authentication mechanism (SPF or DKIM) produced something other than an aligned “pass” result.
- fo=d: Generate a DKIM failure report if the message had a signature that failed evaluation, regardless of its alignment.
- fo=s: Generate an SPF failure report if the message failed SPF evaluation, regardless of its alignment.
* - ``rf``
- string
- No
- afrf, iodef
-
- Report Format (rf): Format for Failure reports.
* - ``ri``
- integer
- No
- 0, 86400, 172800, 259200, 345600
-
- Report Interval (ri): The interval between sending aggregated reports (in seconds).
* - ``rua``
- string
- No
-
-
- Aggregate Emails Report (rua): Addresses for sending Aggregated reports, separated by commas. It is possible to specify mailto: links for sending reports by mail.
* - ``ruf``
- string
- No
-
-
- Failure Emails Report (ruf): Addresses to submit Failure reports, separated by commas. Specifying this tag implies that the owner requires recipient servers to send detailed reports on every message that fails DMARC validation.
\* indicates that it's actually required, but probably already has a valid default value.
Action: ``delete``
------------------
:Added in Version: 7.10.0-2034
:Description: Delete a DNS Record.
Input Parameters
^^^^^^^^^^^^^^^^^
.. list-table::
:widths: auto
:header-rows: 1
* - Name
- Type
- Required?
- Example Values
- Default Values
- Notes
* - ``record_id``
- struct (integer)
- Yes
-
-
-
* - ``confirm_action``
- struct (integer)
- No*
- 1
-
-
\* indicates that it's actually required, but probably already has a valid default value.
Action: ``edit``
----------------
:Added in Version: 7.10.0-2034
:Description: Edit a single domain SPF configuration.
Input Parameters
^^^^^^^^^^^^^^^^^
.. list-table::
:widths: auto
:header-rows: 1
* - Name
- Type
- Required?
- Example Values
- Default Values
- Notes
* - ``host``
- string
- No*
-
- sub.example.com
-
* - ``zone_id``
- integer
- No*
-
-
-
* - ``record_id``
- string
- No
-
-
-
* - ``ttl``
- string
- No*
-
- 43200
- The TTL or Time To Live of a DNS record is a suggestion to other DNS servers of how long to cache the given DNS record. Short TTLs mean your DNS server will be queried more often and longer TTLs mean your DNS server will be queried less often.
If you are planning a change in DNS and need other DNS servers to find out about the change sooner rather than later, it is helpful to drop the TTL temporarily during this change.
* - ``p``
- string
- No*
- none, quarantine, reject
-
- Policy (p): Policy for receiving messages. Determines the policy for receiving messages for the domain and subdomains. - None (p=none): no action is required.
- Quarantine (p=quarantine): the domain possessor asks that failed DMARC messages are considered suspicious. Thus the messages will end up in the spam folder, be flagged as dubious.
- Reject (p=reject): owner is requesting that messages failed by DMARC verification be rejected. The rejection must be done during an SMTP transaction.
* - ``sp``
- string
- No*
- none, quarantine, reject
-
- Subdomain Policy (sp): This tag represents the requested handling policy for subdomains.
* - ``adkim``
- string
- No
- r, s
-
- DKIM Mode (adkim): DKIM record authentication check. It can take the value Relaxed “r”, or Strict “s”. - In relaxed mode, if the DKIM record being verified belongs to the domain d=example.com, and the message is sent from email@news.example.com, the verification will pass.
- In the strict mode, the check will be passed only if the sending comes from an address on the example.com domain. Subdomains will not pass validation.
* - ``aspf``
- string
- No
- r, s
-
- SPF Mode (aspf): SPF record authentication check. By analogy with adkim, it can be Relaxed “r”, or Strict “s”.
* - ``pct``
- integer
- No
- 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100
-
- Percentage (pct): It specifies the number of emails to be filtered, indicated as a percentage. For example, “pct = 20” will filter 20% of emails.
* - ``fo``
- string
- No
- 0, 1, d, s
-
- Report Format (fo): This pertains to how forensic reports are created and presented to DMARC users. - fo=0: Generate a DMARC failure report if all underlying authentication mechanisms (SPF and DKIM) fail to produce an aligned “pass” result.
- fo=1: Generate a DMARC failure report if any underlying authentication mechanism (SPF or DKIM) produced something other than an aligned “pass” result.
- fo=d: Generate a DKIM failure report if the message had a signature that failed evaluation, regardless of its alignment.
- fo=s: Generate an SPF failure report if the message failed SPF evaluation, regardless of its alignment.
* - ``rf``
- string
- No
- afrf, iodef
-
- Report Format (rf): Format for Failure reports.
* - ``ri``
- integer
- No
- 0, 86400, 172800, 259200, 345600
-
- Report Interval (ri): The interval between sending aggregated reports (in seconds).
* - ``rua``
- string
- No
-
-
- Aggregate Emails Report (rua): Addresses for sending Aggregated reports, separated by commas. It is possible to specify mailto: links for sending reports by mail.
* - ``ruf``
- string
- No
-
-
- Failure Emails Report (ruf): Addresses to submit Failure reports, separated by commas. Specifying this tag implies that the owner requires recipient servers to send detailed reports on every message that fails DMARC validation.
\* indicates that it's actually required, but probably already has a valid default value.
Action: ``fail``
----------------
:Added in Version: 7.10.0-2034
:Description: Magic function - test for failure mechanism.
Action: ``listDmarcKeys``
-------------------------
:Added in Version: 7.10.0-2034
:Description: Lists the dmarc keys.
Sample Output
^^^^^^^^^^^^^
.. code-block::
array (
'status' => 0,
'payload' =>
array (
),
'reply_code' => 205,
)
Action: ``reroute``
-------------------
:Added in Version: 7.10.0-2034
:Description: Action to re-route from the current controller to a different one.
Input Parameters
^^^^^^^^^^^^^^^^^
.. list-table::
:widths: auto
:header-rows: 1
* - Name
- Type
- Required?
- Example Values
- Default Values
- Notes
* - ``controller``
- string
- Yes
- Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout
-
-
Action: ``win``
---------------
:Added in Version: 7.10.0-2034
:Description: Magic function - test for testing success mechanism.