Class: Mailkube::Tag

Inherits:
Object
  • Object
show all
Defined in:
lib/mailkube/types.rb,
sig/mailkube/types.rbs

Overview

A free-form name/value tag attached to an outgoing email.

Tags are forwarded to the server, which denormalizes them onto the sending log so you can filter, export and dashboard sends by tag, and so they ride along on delivery webhooks. Tag values are not encrypted, so do not put personal data in them.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, value: "") ⇒ Tag

Returns a new instance of Tag.

Parameters:

  • name (String) —

    the tag name.

  • value (String) (defaults to: "") —

    the tag value; it may be empty.

  • name: (String)
  • value: (String) (defaults to: "") 


23
 
# File 'lib/mailkube/types.rb', line 23

def initialize(name:, value: "") = super

Instance Attribute Details

#name ⇒ String (readonly)

Returns the value of attribute name.

Returns:

  • (String) 


26
27
28
 
# File 'sig/mailkube/types.rbs', line 26

def name
  @name
end

#value ⇒ String (readonly)

Returns the value of attribute value.

Returns:

  • (String) 


27
28
29
 
# File 'sig/mailkube/types.rbs', line 27

def value
  @value
end