From f39f383fbeb00b11d5803654b28b2f324e0eb8a4 Mon Sep 17 00:00:00 2001
From: Yewolf <yyewolf@gmail.com>
Date: Tue, 18 Jul 2023 10:23:34 +0200
Subject: [PATCH] Specified context of use for the RewriteSrc func

---
 policy.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/policy.go b/policy.go
index 1b3f836..931ca82 100644
--- a/policy.go
+++ b/policy.go
@@ -584,6 +584,10 @@ func (p *Policy) AllowURLSchemesMatching(r *regexp.Regexp) *Policy {
 
 // RewriteSrc will rewrite the src attribute of a resource downloading tag
 // (e.g. <img>, <script>, <iframe>) using the provided function.
+//
+// For a mail provider, this can be used to proxify requests and prevent
+// the sender from learning the IP address of the recipient and / or
+// whether the recipient has opened the email (and when / how often).
 func (p *Policy) RewriteSrc(fn urlRewriter) *Policy {
 	p.srcRewriter = fn
 	return p