go-mail/header.go

143 lines
3.7 KiB
Go
Raw Normal View History

2022-03-09 16:52:23 +01:00
package mail
2022-03-10 16:19:51 +01:00
// Header represents a generic mail header field name
2022-03-09 16:52:23 +01:00
type Header string
2022-03-10 16:19:51 +01:00
// AddrHeader represents a address related mail Header field name
type AddrHeader string
2022-03-09 16:52:23 +01:00
2022-03-13 19:24:46 +01:00
// Importance represents a Importance/Priority value string
type Importance int
2022-03-10 16:19:51 +01:00
// List of common generic header field names
const (
// HeaderContentDisposition is the "Content-Disposition" header
HeaderContentDisposition Header = "Content-Disposition"
2022-03-14 10:29:53 +01:00
// HeaderContentID is the "Content-ID" header
HeaderContentID Header = "Content-ID"
2022-03-10 16:56:41 +01:00
// HeaderContentLang is the "Content-Language" header
HeaderContentLang Header = "Content-Language"
// HeaderContentTransferEnc is the "Content-Transfer-Encoding" header
HeaderContentTransferEnc Header = "Content-Transfer-Encoding"
2022-03-10 16:56:41 +01:00
// HeaderContentType is the "Content-Type" header
HeaderContentType Header = "Content-Type"
2022-03-09 16:52:23 +01:00
// HeaderDate represents the "Date" field
// See: https://www.rfc-editor.org/rfc/rfc822#section-5.1
HeaderDate Header = "Date"
2022-03-13 19:24:46 +01:00
// HeaderImportance represents the "Importance" field
HeaderImportance Header = "Importance"
// HeaderInReplyTo represents the "In-Reply-To" field
HeaderInReplyTo Header = "In-Reply-To"
// HeaderListUnsubscribe is the "List-Unsubscribe" header field
HeaderListUnsubscribe Header = "List-Unsubscribe"
// HeaderListUnsubscribePost is the "List-Unsubscribe-Post" header field
HeaderListUnsubscribePost Header = "List-Unsubscribe-Post"
2022-03-09 16:52:23 +01:00
// HeaderMessageID represents the "Message-ID" field for message identification
// See: https://www.rfc-editor.org/rfc/rfc1036#section-2.1.5
HeaderMessageID Header = "Message-ID"
2022-03-10 16:19:51 +01:00
2022-03-10 16:56:41 +01:00
// HeaderMIMEVersion represents the "MIME-Version" field as per RFC 2045
// See: https://datatracker.ietf.org/doc/html/rfc2045#section-4
HeaderMIMEVersion Header = "MIME-Version"
// HeaderPrecedence is the "Precedence" header field
2022-03-10 16:19:51 +01:00
HeaderPrecedence Header = "Precedence"
2022-03-13 19:24:46 +01:00
// HeaderPriority represents the "Priority" field
HeaderPriority Header = "Priority"
// HeaderReplyTo is the "Reply-To" header field
HeaderReplyTo Header = "Reply-To"
// HeaderSubject is the "Subject" header field
2022-03-10 16:19:51 +01:00
HeaderSubject Header = "Subject"
2022-03-13 19:24:46 +01:00
// HeaderXMSMailPriority is the "X-MSMail-Priority" header field
HeaderXMSMailPriority Header = "X-MSMail-Priority"
// HeaderXPriority is the "X-Priority" header field
HeaderXPriority Header = "X-Priority"
2022-03-10 16:19:51 +01:00
)
// List of common generic header field names
const (
// HeaderBcc is the "Blind Carbon Copy" header field
2022-03-10 16:19:51 +01:00
HeaderBcc AddrHeader = "Bcc"
// HeaderCc is the "Carbon Copy" header field
2022-03-10 16:19:51 +01:00
HeaderCc AddrHeader = "Cc"
// HeaderFrom is the "From" header field
2022-03-10 16:19:51 +01:00
HeaderFrom AddrHeader = "From"
// HeaderTo is the "Receipient" header field
2022-03-10 16:19:51 +01:00
HeaderTo AddrHeader = "To"
2022-03-09 16:52:23 +01:00
)
2022-03-13 19:24:46 +01:00
// List of Importance values
const (
ImportanceLow Importance = iota
ImportanceNormal
ImportanceHigh
ImportanceNonUrgent
ImportanceUrgent
)
// NumString returns the importance number string based on the Importance
func (i Importance) NumString() string {
switch i {
case ImportanceNonUrgent:
return "0"
case ImportanceLow:
return "0"
case ImportanceHigh:
return "1"
case ImportanceUrgent:
return "1"
default:
return ""
}
}
2022-03-13 19:28:40 +01:00
// XPrioString returns the X-Priority number string based on the Importance
func (i Importance) XPrioString() string {
switch i {
case ImportanceNonUrgent:
return "5"
case ImportanceLow:
return "5"
case ImportanceHigh:
return "1"
case ImportanceUrgent:
return "1"
default:
return ""
}
}
2022-03-13 19:24:46 +01:00
// String returns the importance string based on the Importance
func (i Importance) String() string {
switch i {
case ImportanceNonUrgent:
return "non-urgent"
case ImportanceLow:
return "low"
case ImportanceHigh:
return "high"
case ImportanceUrgent:
return "urgent"
default:
return ""
}
}