email

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DelieryStatusSent = "Sent"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Attachment

type Attachment struct {
	FileName    string // Name of the file (e.g., invoice.pdf)
	ContentType string // MIME type (e.g., application/pdf)
	Content     []byte // File content in bytes
}

Attachment represents a file attachment for raw emails.

type HeaderParams

type HeaderParams struct {
	From        string
	To          string
	Subject     string
	MIMEVersion string
	ContentType string
	Boundary    string
}

func (*HeaderParams) ToString

func (h *HeaderParams) ToString() string

type InlineAttachment

type InlineAttachment struct {
	ContentID   string // Content ID to reference the image in HTML
	FileName    string // Name of the file (optional)
	ContentType string // MIME type (e.g., image/png)
	Content     []byte // File content in bytes
}

InlineAttachment represents inline images embedded into HTML content.

type SendEmailResult

type SendEmailResult struct {
	MessageID        string            // Unique identifier for the sent email
	RequestID        string            // Unique identifier for the request to send the email
	DeliveryStatus   string            // Delivery status (e.g., Sent, Pending)
	ProviderMetadata map[string]string // Additional metadata provided by the email service
}

type SendRawEmailInput

type SendRawEmailInput struct {
	FromName         string             // Optional sender display name
	FromAddress      string             // Sender's email address
	ToAddresses      []string           // List of recipient email addresses
	CcAddresses      []string           // List of CC recipient email addresses
	BccAddresses     []string           // List of BCC recipient email addresses
	ReplyToAddress   []string           // Reply-To email addresses
	Subject          string             // Email subject
	HtmlBody         string             // HTML content of the email
	TextBody         string             // Plain text content of the email
	Attachments      []Attachment       // List of attachments
	InlineImages     []InlineAttachment // Inline images for embedding in email
	Headers          map[string]string  // Custom email headers
	Tags             map[string]string  // Tags for tracking emails
	PixelTrackingURL string             // Optional tracking pixel URL
}

SendRawEmailInput is used for sending raw emails with attachments and inline images.

type SendSimpleEmailInput

type SendSimpleEmailInput struct {
	FromName         string            // Optional sender display name
	FromAddress      string            // Sender's email address
	ToAddresses      []string          // List of recipient email addresses
	CcAddresses      []string          // List of CC recipient email addresses
	BccAddresses     []string          // List of BCC recipient email addresses
	ReplyToAddress   []string          // Reply-To email addresses
	Subject          string            // Email subject
	HtmlBody         string            // HTML content of the email
	TextBody         string            // Plain text content of the email
	Headers          map[string]string // Custom email headers
	Tags             map[string]string // Tags for tracking emails
	PixelTrackingURL string            // Optional tracking pixel URL
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL