normalize

Documentation

Overview

Package normalize contains functions to normalize usernames, domains and addresses.

Index

• func Addr(addr string) (string, error)
• func Domain(domain string) (string, error)
• func DomainToUnicode(addr string) (string, error)
• func StringToCRLF(in string) string
• func ToCRLF(in []byte) []byte
• func User(user string) (string, error)

Functions

func Addr

func Addr(addr string) (string, error)

Addr normalizes an email address, applying User and Domain to its respective components. On error, it will also return the original address to simplify callers.

func Domain

func Domain(domain string) (string, error)

Domain normalizes a DNS domain into a cleaned UTF-8 form. On error, it will also return the original domain to simplify callers.

func DomainToUnicode

func DomainToUnicode(addr string) (string, error)

DomainToUnicode takes an address with an ASCII domain, and convert it to Unicode as per IDNA, including basic normalization. The user part is unchanged.

func StringToCRLF

func StringToCRLF(in string) string

StringToCRLF is like ToCRLF, but operates on strings.

func ToCRLF

func ToCRLF(in []byte) []byte

ToCRLF converts the given buffer to CRLF line endings. If a line has a preexisting CRLF, it leaves it be. It assumes that CR is never used on its own.

func User

func User(user string) (string, error)

User normalizes an username using PRECIS. On error, it will also return the original username to simplify callers.