Class: SocketLabs::InjectionApi::SendResult

Inherits:
Object
  • Object
show all
Defined in:
lib/socketlabs/injectionapi/send_result.rb

Class Method Summary collapse

Class Method Details

.enumObject

Send Result hash



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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'lib/socketlabs/injectionapi/send_result.rb', line 7

def self.enum
    {
  # An error has occurred that was unforeseen

  "UnknownError" =>          {
      :name => "UnknownError",
      :value =>0,
      :message =>"An error has occurred that was unforeseen"
    },

  # A timeout occurred sending the message

  "Timeout" =>
    {
      :name =>"Timeout",
      :value =>1,
      :message =>"A timeout occurred sending the message"
    },

  # Successful send of message

  "Success"  =>
    {
      :name =>"Success",
      :value =>2,
      :message =>"Successful send of message"
    },

  # Warnings were found while sending the message

  "Warning"  =>
    {
      :name =>"Warning",
      :value =>3,
      :message =>"Warnings were found while sending the message"
    },

  # Internal server error

  "InternalError" =>
    {
      :name =>"InternalError",
      :value =>4,
      :message =>"Internal server error"
    },

  # Message has exceeded the size limit

  "MessageTooLarge" =>
    {
      :name =>"MessageTooLarge",
      :value =>5,
      :message =>"Message has exceeded the size limit"
    },

  # Message exceeded the maximum allowed recipient count

  "TooManyRecipients" =>
    {
      :name =>"TooManyRecipients",
      :value =>6,
      :message =>"Message exceeded the maximum allowed recipient count"
    },

  # The message request contained invalid data

  "InvalidData" =>
    {
      :name =>"InvalidData",
      :value =>7,
      :message =>"The message request contained invalid data"
    },

  # The account is over the send quota, rate limit exceeded

  "OverQuota" =>
    {
      :name =>"OverQuota",
      :value =>8,
      :message =>"The account is over the send quota, rate limit exceeded"
    },

  # Too many errors occurred sending the message

  "TooManyErrors" =>
    {
      :name =>"TooManyErrors",
      :value =>9,
      :message =>"Too many errors occurred sending the message"
    },

  # The serverId and apiKey combination is not valid

  "InvalidAuthentication" =>
    {
      :name =>"InvalidAuthentication",
      :value =>10,
      :message =>"The serverId and apiKey combination is not valid"
    },

  # The account has been disabled

  "AccountDisabled" =>
    {
      :name =>"AccountDisabled",
      :value =>11,
      :message =>"The account has been disabled"
    },

  # Too many messages were found on the request

  "TooManyMessages" =>
    {
      :name =>"TooManyMessages",
      :value =>12,
      :message =>"Too many messages were found on the request"
    },

  # No valid recipients were found on the message

  "NoValidRecipients" =>
    {
      :name =>"NoValidRecipients",
      :value =>13,
      :message =>"No valid recipients were found on the message"
    },

  # An invalid recipient address was found on the message

  "InvalidAddress" =>
    {
      :name =>"InvalidAddress",
      :value =>14,
      :message =>"An invalid recipient address was found on the message"
    },

  # An invalid attachment was found on the message

  "InvalidAttachment" =>
    {
      :name =>"InvalidAttachment",
      :value =>15,
      :message =>"An invalid attachment was found on the message"
    },

  # No messages were found on the request

  "NoMessages" =>
    {
      :name =>"NoMessages",
      :value =>16,
      :message =>"No messages were found on the request"
    },

  # No message content was found on the request

  "EmptyMessage" =>
    {
      :name =>"EmptyMessage",
      :value =>17,
      :message =>"No message content was found on the request"
    },

  # No subject was found on the message

  "EmptySubject" =>
    {
      :name =>"EmptySubject",
      :value =>18,
      :message =>"No subject was found on the message"
    },

  # An invalid From address was found on the message

  "InvalidFromAddress" =>
    {
      :name =>"InvalidFromAddress",
      :value =>19,
      :message =>"An invalid From address was found on the message"
    },

  # No To addresses were found on the message

  "EmptyToAddress" =>
    {
      :name =>"EmptyToAddress",
      :value =>20,
      :message =>"No To addresses were found on the message"
    },

  # No valid message body was found on the message

  "NoValidBodyParts" =>
    {
      :name =>"NoValidBodyParts",
      :value =>21,
      :message =>"No valid message body was found on the message"
    },

  # An invalid templateId was found on the message

  "InvalidTemplateId" =>
    {
      :name =>"InvalidTemplateId",
      :value =>22,
      :message =>"An invalid templateId was found on the message"
    },

  # The specified templateId has no content associated with it

  "TemplateHasNoContent" =>
    {
      :name =>"TemplateHasNoContent",
      :value =>23,
      :message =>"The specified templateId has no content associated with it"
    },

  # A conflict occurred due to the use of templateId and HtmlBody or TextBody

  "MessageBodyConflict" =>
    {
      :name =>"MessageBodyConflict",
      :value =>24,
      :message =>"A conflict occurred due to the use of templateId and HtmlBody or TextBody"
    },

  # Invalid merge data was found on the message

  "InvalidMergeData" =>
    {
      :name =>"InvalidMergeData",
      :value =>25,
      :message =>"Invalid merge data was found on the message"
    },

  # SDK Validation Error: Authentication validation failed, missing or invalid ServerId or ApiKey

  "AuthenticationValidationFailed" =>
    {
      :name =>"AuthenticationValidationFailed",
      :value =>26,
      :message =>"SDK Validation Error: Authentication validation failed, missing or invalid ServerId or ApiKey"
    },

  # SDK Validation Error: Message exceeded maximum recipient count

  "RecipientValidationMaxExceeded" =>
    {
      :name =>"RecipientValidationMaxExceeded",
      :value =>27,
      :message =>"SDK Validation Error: Message exceeded maximum recipient count"
    },

  # SDK Validation Error: No recipients were found in the message

  "RecipientValidationNoneInMessage" =>
    {
      :name =>"RecipientValidationNoneInMessage",
      :value =>28,
      :message =>"SDK Validation Error: No recipients were found in the message"
    },

  # SDK Validation Error: Message is missing From address

  "EmailAddressValidationMissingFrom" =>
    {
      :name =>"EmailAddressValidationMissingFrom",
      :value =>29,
      :message =>"SDK Validation Error: Message is missing From address"
    },

  # SDK Validation Error: Message is missing To address(es)

  "RecipientValidationMissingTo" =>
    {
      :name =>"RecipientValidationMissingTo",
      :value =>30,
      :message =>"SDK Validation Error: Message is missing To address(es)"
    },

  # SDK Validation Error: Message contains an invalid From address

  "EmailAddressValidationInvalidFrom" =>
    {
      :name =>"EmailAddressValidationInvalidFrom",
      :value =>31,
      :message =>"SDK Validation Error: Message contains an invalid From address"
    },

  # SDK Validation Error: Message does not contain a subject

  "MessageValidationEmptySubject" =>
    {
      :name =>"MessageValidationEmptySubject",
      :value =>32,
      :message =>"SDK Validation Error: Message does not contain a subject"
    },

  # SDK Validation Error: Message does not contain a message body

  "MessageValidationEmptyMessage" =>
    {
      :name =>"MessageValidationEmptyMessage",
      :value =>33,
      :message =>"SDK Validation Error: Message does not contain a message body"
    },

  # SDK Validation Error: Message contains invalid custom headers

  "MessageValidationInvalidCustomHeaders" =>
    {
      :name =>"MessageValidationInvalidCustomHeaders",
      :value =>34,
      :message =>"SDK Validation Error: Message contains invalid custom headers"
    },

  # SDK Validation Error: Message contains invalid ReplyTo address

  "RecipientValidationInvalidReplyTo" =>
    {
      :name =>"RecipientValidationInvalidReplyTo",
      :value =>35,
      :message =>"SDK Validation Error: Message contains invalid ReplyTo address"
    },

  # SDK Validation Error: Message contains invalid recipients

  "RecipientValidationInvalidRecipients" =>
    {
      :name =>"RecipientValidationInvalidRecipients",
      :value =>36,
      :message =>"SDK Validation Error: Message contains invalid recipients"
    },

  # SDK Validation Error: Expected messageType of basic or bulk

  "MessageValidationInvalidMessageType" =>
    {
      :name =>"MessageValidationInvalidMessageType",
      :value =>37,
      :message =>"SDK Validation Error: Expected messageType of basic or bulk"

    },

  # SDK Validation Error: Message contains invalid metadata

  "MessageValidationInvalidMetadata" =>
    {
      :name =>"MessageValidationInvalidMetadata",
      :value =>38,
      :message =>"SDK Validation Error: Message contains invalid metadata"
    }

    }
end