nswdpc/silverstripe-userforms-ipcollection

Collect IP addresses of submissions, taking into account proxies

Maintainers

Package info

github.com/nswdpc/silverstripe-userforms-ipcollection

Type:silverstripe-vendormodule

pkg:composer/nswdpc/silverstripe-userforms-ipcollection

Transparency log

Statistics

Installs: 4 048

Dependents: 1

Suggesters: 0

Stars: 0

Open Issues: 0

v2.0.0 2026-07-30 03:09 UTC

README

This modules allows messages generated from user form submissions to include an OriginatingIP, on a per-recipient basis.

Installation

composer require nswdpc/silverstripe-userforms-ipcollection

License

BSD-3-Clause

Documentation

All user form email templates in your project or theme (e.g SubmittedFormEmail.ss) should handle including the {$OriginatingIP} template variable as in the example below.

These templates can usually be found in the email directory of a project or its theme(s):

  • ./app/templates/email/
  • ./my-theme/templates/email/
<% if $OriginatingIP %>
<p>Originating IP: {$OriginatingIP}</p>
<% end_if %>

If you are not seeing the value in the email, check your SilverStripe\View\SSViewer.themes configuration.

After installation

  1. For every recipient who should receive an originating IP (or IPs), check the 'Include the originating IP address' checkbox on the "Email Content" tab.

When a submission is made, the originating IP will be determined based on the request.

The Originating IP may not be a single IP address, for instance it could include any number of proxy IPs.

Maintainers

  • PD Web Team

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.