/
message.go
297 lines (275 loc) · 12 KB
/
message.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
package events
import "fmt"
type Delivery struct {
EventCommon
Binding string `json:"binding"`
BindingGroup string `json:"binding_group"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
DeliveryMethod string `json:"delv_method"`
DeviceToken string `json:"device_token"`
IPAddress string `json:"ip_address"`
MessageID string `json:"message_id"`
MessageFrom string `json:"msg_from"`
MessageSize string `json:"msg_size"`
Retries string `json:"num_retries"`
QueueTime string `json:"queue_time"`
Metadata interface{} `json:"rcpt_meta"`
Tags []string `json:"rcpt_tags"`
Recipient string `json:"rcpt_to"`
RecipientType string `json:"rcpt_type"`
ReceiveProtocol string `json:"recv_method"`
RoutingDomain string `json:"routing_domain"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
}
// String returns a brief summary of a Delivery event
func (d *Delivery) String() string {
return fmt.Sprintf("%s D %s %s => %s",
d.Timestamp, d.TransmissionID, d.Binding, d.Recipient)
}
// ECLog emits a Delivery in the same format that it would be logged to mainlog.ec:
// https://support.messagesystems.com/docs/web-ref/log_formats.version_3.php
func (d *Delivery) ECLog() string {
return fmt.Sprintf("%s@%s@@@D@%s@%s@%s@%s@%s@%s@%s",
d.Timestamp, d.MessageID, d.RoutingDomain, d.MessageSize,
d.Binding, d.BindingGroup, d.Retries, d.QueueTime, d.IPAddress)
}
type Injection struct {
EventCommon
Binding string `json:"binding"`
BindingGroup string `json:"binding_group"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
MessageID string `json:"message_id"`
MessageFrom string `json:"msg_from"`
MessageSize string `json:"msg_size"`
Metadata interface{} `json:"rcpt_meta"`
Pathway string `json:"pathway"`
PathwayGroup string `json:"pathway_group"`
Tags []string `json:"rcpt_tags"`
Recipient string `json:"rcpt_to"`
RecipientType string `json:"rcpt_type"`
ReceiveProtocol string `json:"recv_method"`
RoutingDomain string `json:"routing_domain"`
Subject string `json:"subject"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
}
// String returns a brief summary of a GenerationFailure event
func (i *Injection) String() string {
return fmt.Sprintf("%s R %s %s => %s",
i.Timestamp, i.TransmissionID, i.Binding, i.Recipient)
}
// ECLog emits an Injection in the same format that it would be logged to mainlog.ec:
// https://support.messagesystems.com/docs/web-ref/log_formats.version_3.php
func (i *Injection) ECLog() string {
return fmt.Sprintf("%s@%s@@@R@%s@%s@@%s@%s@%s@%s",
i.Timestamp, i.MessageID, i.Recipient, i.MessageFrom,
i.MessageSize, i.ReceiveProtocol,
i.Binding, i.BindingGroup)
}
type Bounce struct {
EventCommon
Binding string `json:"binding"`
BindingGroup string `json:"binding_group"`
BounceClass string `json:"bounce_class"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
DeliveryMethod string `json:"delv_method"`
DeviceToken string `json:"device_token"`
ErrorCode string `json:"error_code"`
IPAddress string `json:"ip_address"`
MessageID string `json:"message_id"`
MessageFrom string `json:"msg_from"`
MessageSize string `json:"msg_size"`
Retries string `json:"num_retries"`
Metadata map[string]string `json:"rcpt_meta"`
Tags []string `json:"rcpt_tags"`
Recipient string `json:"rcpt_to"`
RecipientType string `json:"rcpt_type"`
RawReason string `json:"raw_reason"`
Reason string `json:"reason"`
ReceiveProtocol string `json:"recv_method"`
RoutingDomain string `json:"routing_domain"`
Subject string `json:"subject"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
}
// String returns a brief summary of a Bounce event
func (b *Bounce) String() string {
return fmt.Sprintf("%s B %s %s => %s %s: %s",
b.Timestamp, b.TransmissionID, b.Binding, b.Recipient,
b.BounceClass, b.RawReason)
}
// ECLog emits a Bounce in the same format that it would be logged to bouncelog.ec:
// https://support.messagesystems.com/docs/web-ref/log_formats.version_3.php
func (b *Bounce) ECLog() string {
return fmt.Sprintf("%s@%s@@@B@%s@%s@%s@%s@@%s@%s@%s@%s",
b.Timestamp, b.MessageID, b.Recipient, b.MessageFrom,
b.Binding, b.BindingGroup, b.BounceClass, b.MessageSize,
b.IPAddress, b.RawReason)
}
type OutOfBand struct {
EventCommon
Binding string `json:"binding"`
BindingGroup string `json:"binding_group"`
BounceClass string `json:"bounce_class"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
DeliveryMethod string `json:"delv_method"`
DeviceToken string `json:"device_token"`
ErrorCode string `json:"error_code"`
MessageID string `json:"message_id"`
MessageFrom string `json:"msg_from"`
Recipient string `json:"rcpt_to"`
RawReason string `json:"raw_reason"`
Reason string `json:"reason"`
ReceiveProtocol string `json:"recv_method"`
RoutingDomain string `json:"routing_domain"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
}
// String returns a brief summary of a Bounce event
func (b *OutOfBand) String() string {
return fmt.Sprintf("%s OOB [%s] %s => %s %s: %s",
b.Timestamp, b.CampaignID, b.Binding, b.Recipient,
b.BounceClass, b.RawReason)
}
// ECLog emits an OutOfBand in the same format that it would be logged to bouncelog.ec:
// https://support.messagesystems.com/docs/web-ref/log_formats.version_3.php
func (b *OutOfBand) ECLog() string {
return fmt.Sprintf("%s@%s@@@B@%s@%s@%s@%s@@%s@@@%s",
b.Timestamp, b.MessageID, b.Recipient, b.MessageFrom,
b.Binding, b.BindingGroup, b.BounceClass, b.RawReason)
}
type SpamComplaint struct {
EventCommon
Binding string `json:"binding"`
BindingGroup string `json:"binding_group"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
DeliveryMethod string `json:"delv_method"`
FeedbackType string `json:"fbtype"`
FriendlyFrom string `json:"friendly_from"`
MessageID string `json:"message_id"`
Metadata interface{} `json:"rcpt_meta"`
Tags []string `json:"rcpt_tags"`
Recipient string `json:"rcpt_to"`
RecipientType string `json:"rcpt_type"`
ReportedBy string `json:"report_by"`
ReportedTo string `json:"report_to"`
Subject string `json:"subject"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
UserString string `json:"user_str"`
}
// String returns a brief summary of a SpamComplaint event
func (p *SpamComplaint) String() string {
return fmt.Sprintf("%s S %s %s %s => %s (%s)",
p.Timestamp, p.TransmissionID, p.Binding, p.ReportedBy, p.ReportedTo, p.Recipient)
}
type PolicyRejection struct {
EventCommon
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
ErrorCode string `json:"error_code"`
MessageID string `json:"message_id"`
MessageFrom string `json:"msg_from"`
Metadata interface{} `json:"rcpt_meta"`
Pathway string `json:"pathway"`
PathwayGroup string `json:"pathway_group"`
Tags []string `json:"rcpt_tags"`
RawReason string `json:"raw_reason"`
Reason string `json:"reason"`
Recipient string `json:"rcpt_to"`
RecipientType string `json:"rcpt_type"`
ReceiveProtocol string `json:"recv_method"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
}
// String returns a brief summary of a PolicyRejection event
func (p *PolicyRejection) String() string {
return fmt.Sprintf("%s PR %s [%s] => %s %s: %s",
p.Timestamp, p.TransmissionID, p.CampaignID, p.Recipient,
p.ErrorCode, p.RawReason)
}
type Delay struct {
EventCommon
Binding string `json:"binding"`
BindingGroup string `json:"binding_group"`
BounceClass string `json:"bounce_class"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
DeliveryMethod string `json:"delv_method"`
DeviceToken string `json:"device_token"`
ErrorCode string `json:"error_code"`
IPAddress string `json:"ip_address"`
MessageID string `json:"message_id"`
MessageFrom string `json:"msg_from"`
MessageSize string `json:"msg_size"`
Retries string `json:"num_retries"`
QueueTime string `json:"queue_time"`
Metadata interface{} `json:"rcpt_meta"`
Tags []string `json:"rcpt_tags"`
Recipient string `json:"rcpt_to"`
RecipientType string `json:"rcpt_type"`
RawReason string `json:"raw_reason"`
Reason string `json:"reason"`
RoutingDomain string `json:"routing_domain"`
Subject string `json:"subject"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
}
// String returns a brief summary of a Delay event
func (d *Delay) String() string {
return fmt.Sprintf("%s T %s => %s %s: %s",
d.Timestamp, d.MessageFrom, d.Recipient, d.BounceClass, d.RawReason)
}
// ECLog emits a Delay in the same format that it would be logged to bouncelog.ec:
// https://support.messagesystems.com/docs/web-ref/log_formats.version_3.php
func (d *Delay) ECLog() string {
return fmt.Sprintf("%s@%s@@@T@%s@%s@%s@%s@@%s@%s@%s@%s",
d.Timestamp, d.MessageID, d.Recipient, d.MessageFrom,
d.Binding, d.BindingGroup, d.BounceClass, d.MessageSize,
d.IPAddress, d.RawReason)
}
type SMSStatus struct {
EventCommon
CustomerID string `json:"customer_id"`
DeliveryMethod string `json:"delv_method"`
// TODO: `json:"dr_latency"`
IPAddress string `json:"ip_address"`
RawReason string `json:"raw_reason"`
Reason string `json:"reason"`
RoutingDomain string `json:"routing_domain"`
Destination string `json:"sms_dst"`
DestinationNPI string `json:"sms_dst_npi"`
DestinationTON string `json:"sms_dst_ton"`
RemoteIDs []string `json:"sms_remoteids"`
Source string `json:"sms_src"`
SourceNPI string `json:"sms_src_npi"`
SourceTON string `json:"sms_src_ton"`
Text string `json:"sms_text"`
StatusType string `json:"stat_type"`
StatusState string `json:"stat_state"`
// TODO: SubAccountID string `json:"subaccount_id"`
Timestamp Timestamp `json:"timestamp"`
}
// String returns a brief summary of a Delay event
func (e *SMSStatus) String() string {
return fmt.Sprintf("%s SMS", e.Timestamp) // TODO: Improve message.
}