client

Documentation

Overview

Package client provides a basic REST client for TempMail

Index

• type Client
  • func New(baseURL string) (*Client, error)
  • func (c *Client) DeleteMessage(name, id string) error
  • func (c *Client) GetMessage(name, id string) (message *Message, err error)
  • func (c *Client) GetMessageSource(name, id string) (*bytes.Buffer, error)
  • func (c *Client) ListMailbox(name string) (headers []*MessageHeader, err error)
  • func (c *Client) MarkSeen(name, id string) error
  • func (c *Client) PurgeMailbox(name string) error
• type Message
  • func (m *Message) Delete() error
  • func (m *Message) GetSource() (*bytes.Buffer, error)
• type MessageHeader
  • func (h *MessageHeader) Delete() error
  • func (h *MessageHeader) GetMessage() (message *Message, err error)
  • func (h *MessageHeader) GetSource() (*bytes.Buffer, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client accesses the TempMail REST API v1

func New

func New(baseURL string) (*Client, error)

New creates a new v1 REST API client given the base URL of an TempMail server, ex: "http://localhost:9000"

func (*Client) DeleteMessage

func (c *Client) DeleteMessage(name, id string) error

DeleteMessage deletes a single message given the mailbox name and message ID.

func (*Client) GetMessage

func (c *Client) GetMessage(name, id string) (message *Message, err error)

GetMessage returns the message details given a mailbox name and message ID.

func (*Client) GetMessageSource

func (c *Client) GetMessageSource(name, id string) (*bytes.Buffer, error)

GetMessageSource returns the message source given a mailbox name and message ID.

func (*Client) ListMailbox

func (c *Client) ListMailbox(name string) (headers []*MessageHeader, err error)

ListMailbox returns a list of messages for the requested mailbox

func (*Client) MarkSeen

func (c *Client) MarkSeen(name, id string) error

MarkSeen marks the specified message as having been read.

func (*Client) PurgeMailbox

func (c *Client) PurgeMailbox(name string) error

PurgeMailbox deletes all messages in the given mailbox

type Message

type Message struct {
	*model.JSONMessageV1
	// contains filtered or unexported fields
}

Message represents an TempMail message including content

func (*Message) Delete

func (m *Message) Delete() error

Delete deletes this message from the mailbox

func (*Message) GetSource

func (m *Message) GetSource() (*bytes.Buffer, error)

GetSource returns the source for this message

type MessageHeader

type MessageHeader struct {
	*model.JSONMessageHeaderV1
	// contains filtered or unexported fields
}

MessageHeader represents an TempMail message sans content

func (*MessageHeader) Delete

func (h *MessageHeader) Delete() error

Delete deletes this message from the mailbox

func (*MessageHeader) GetMessage

func (h *MessageHeader) GetMessage() (message *Message, err error)

GetMessage returns this message with content

func (*MessageHeader) GetSource

func (h *MessageHeader) GetSource() (*bytes.Buffer, error)

GetSource returns the source for this message