Class: GovDelivery::TMS::EmailRecipient
- Inherits:
-
Object
- Object
- GovDelivery::TMS::EmailRecipient
- Includes:
- InstanceResource
- Defined in:
- lib/govdelivery/tms/resource/email_recipient.rb
Overview
An EmailRecipient is used in conjunction with an EmailMessage to send email.
Instance Attribute Summary collapse
-
#completed_at ⇒ Object
readonly
Returns the value of attribute completed_at.
-
#email ⇒ String
The recipient email address.
-
#error_message ⇒ Object
readonly
Returns the value of attribute error_message.
-
#macros ⇒ Hash
A dictionary of key/value pairs to resolve in the subject and body as macros.
-
#status ⇒ Object
readonly
Returns the value of attribute status.
Attributes included from InstanceResource
Instance Method Summary collapse
-
#clicks ⇒ Object
A CollectionResource of EmailRecipientClicks for this EmailRecipient.
-
#opens ⇒ Object
A CollectionResource of EmailRecipientOpens for this EmailRecipient.
Methods included from InstanceResource
Instance Attribute Details
#completed_at ⇒ Object (readonly)
Returns the value of attribute completed_at.
1 2 3 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 1 def completed_at @completed_at end |
#email ⇒ String
The recipient email address
14 15 16 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 14 def email @email end |
#error_message ⇒ Object (readonly)
Returns the value of attribute error_message.
1 2 3 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 1 def @error_message end |
#macros ⇒ Hash
A dictionary of key/value pairs to resolve in the subject and body as macros. This value can be nil.
14 15 16 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 14 def macros @macros end |
#status ⇒ Object (readonly)
Returns the value of attribute status.
1 2 3 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 1 def status @status end |
Instance Method Details
#clicks ⇒ Object
A CollectionResource of EmailRecipientClicks for this EmailRecipient
29 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 29 readonly_collection_attribute :clicks, 'EmailRecipientClicks' |
#opens ⇒ Object
A CollectionResource of EmailRecipientOpens for this EmailRecipient
25 |
# File 'lib/govdelivery/tms/resource/email_recipient.rb', line 25 readonly_collection_attribute :opens, 'EmailRecipientOpens' |