Class: Mailscope::Storage::Base

Inherits:

Object

• Object
• Mailscope::Storage::Base

Defined in:

lib/mailscope/storage/base.rb

Overview

The contract every adapter has to satisfy. Kept deliberately small so a database- or Redis-backed adapter stays a weekend of work.

Direct Known Subclasses

Filesystem

Instance Method Summary

• #all ⇒ Array<Mailscope::Message>

  Newest first.

• #clear ⇒ Object
• #delete(id) ⇒ Object
• #find(id) ⇒ Mailscope::Message^?
• #prune ⇒ Object

  Applies the retention policy (max_letters:, max_age:) and returns the number of messages removed.

• #read_attachment(id, attachment_id) ⇒ String^?

  Decoded attachment bytes.

• #read_raw(id) ⇒ String

  Raw RFC822 source.

• #revision ⇒ Object

  Cheap change token so the browser can poll without transferring the list.

• #store(mail) ⇒ Object

  Persists a delivered Mail::Message.

Instance Method Details

#all ⇒ Array<Mailscope::Message>

Returns newest first.

Returns:

• (Array<Mailscope::Message>) —

  newest first

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 9

def all = raise(NotImplementedError)

#clear ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 25

def clear = raise(NotImplementedError)

#delete(id) ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 23

def delete(id) = raise(NotImplementedError)

#find(id) ⇒ Mailscope::Message^?

Returns:

• (Mailscope::Message, nil)

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 12

def find(id) = raise(NotImplementedError)

#prune ⇒ Object

Applies the retention policy (max_letters:, max_age:) and returns the number of messages removed. Adapters without retention keep this no-op.

# File 'lib/mailscope/storage/base.rb', line 29

def prune(**) = 0

#read_attachment(id, attachment_id) ⇒ String^?

Returns decoded attachment bytes.

Returns:

• (String, nil) —

  decoded attachment bytes

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 21

def read_attachment(id, attachment_id) = raise(NotImplementedError)

#read_raw(id) ⇒ String

Returns raw RFC822 source.

Returns:

• (String) —

  raw RFC822 source

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 18

def read_raw(id) = raise(NotImplementedError)

#revision ⇒ Object

Cheap change token so the browser can poll without transferring the list.

# File 'lib/mailscope/storage/base.rb', line 32

def revision = all.first&.id.to_s

#store(mail) ⇒ Object

Persists a delivered Mail::Message. @return [String] the new id

Raises:

• (NotImplementedError)

# File 'lib/mailscope/storage/base.rb', line 15

def store(mail) = raise(NotImplementedError)