aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan Engelhardt <[email protected]>2024-01-30 11:41:49 +0000
committerGitHub <[email protected]>2024-01-30 11:41:49 +0000
commitc3c6242ed135f9eca805380394791d17b0fc7a63 (patch)
treebee373b6256682327a5662c7ea62328e83067053
parenturl: support IPv6 literals (RFC 2732) (#292) (diff)
downloadvmime-c3c6242ed135f9eca805380394791d17b0fc7a63.tar.gz
vmime-c3c6242ed135f9eca805380394791d17b0fc7a63.zip
url: add remark to documentation about hardcoded // substring (#293)
-rw-r--r--src/vmime/utility/url.hpp5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/vmime/utility/url.hpp b/src/vmime/utility/url.hpp
index 8dfa3c45..e8e818f0 100644
--- a/src/vmime/utility/url.hpp
+++ b/src/vmime/utility/url.hpp
@@ -35,7 +35,10 @@ namespace utility {
/** This class represents a Uniform Resource Locator (a pointer
- * to a "resource" on the World Wide Web).
+ * to a "resource" on the World Wide Web). It is meant to be only
+ * used in conjunction with vmime, as all URLs and URL components are
+ * interpreted as, or re-written into, Common Internet Scheme (RFC 1738 ยง3.1)
+ * form. (As such, it cannot be used with e.g. the mailto: scheme.)
*
* Format:
* "protocol://[username[:password]@]host[:port][/path]"