-
Notifications
You must be signed in to change notification settings - Fork 9
/
mailosaurCommands.d.ts
463 lines (418 loc) · 12.7 KB
/
mailosaurCommands.d.ts
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
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
/// <reference types="cypress" />
/**
* @class
* Initializes a new instance of the SpamAssassinRule class.
* @constructor
* @member {number} [score]
* @member {string} [rule]
* @member {string} [description]
*/
export interface SpamAssassinRule {
score?: number;
rule?: string;
description?: string;
}
/**
* @class
* Initializes a new instance of the SpamFilterResults class.
* @constructor
* @member {array} [spamAssassin]
*/
export interface SpamFilterResults {
spamAssassin?: SpamAssassinRule[];
}
/**
* @class
* Initializes a new instance of the SpamAnalysisResult class.
* @constructor
* @member {object} [spamFilterResults]
* @member {array} [spamFilterResults.spamAssassin]
* @member {number} [score]
*/
export interface SpamAnalysisResult {
spamFilterResults?: SpamFilterResults;
score?: number;
}
/**
* @class
* Initializes a new instance of the MessageAddress class.
* @constructor
* @member {string} [name] Display name, if one is specified.
* @member {string} [email] Email address (applicable to email messages).
* @member {string} [phone] Phone number (applicable to SMS messages).
*/
export interface MessageAddress {
name?: string;
email?: string;
phone?: string;
}
/**
* @class
* Initializes a new instance of the Link class.
* @constructor
* @member {string} [href]
* @member {string} [text]
*/
export interface Link {
href?: string;
text?: string;
}
/**
* @class
* Initializes a new instance of the Image class.
* @constructor
* @member {string} [src]
* @member {string} [alt]
*/
export interface Image {
src?: string;
alt?: string;
}
/**
* @class
* Initializes a new instance of the MessageContent class.
* @constructor
* @member {array} [links]
* @member {array} [images]
* @member {string} [body]
*/
export interface MessageContent {
links?: Link[];
images?: Image[];
body?: string;
}
/**
* @class
* Initializes a new instance of the Attachment class.
* @constructor
* @member {uuid} id
* @member {string} [contentType]
* @member {string} [fileName]
* @member {string} [contentId]
* @member {number} [length]
* @member {string} [url]
*/
export interface Attachment {
id: string;
contentType?: string;
fileName?: string;
contentId?: string;
length?: number;
url?: string;
}
/**
* @class
* Initializes a new instance of the MessageHeader class.
* @constructor
* @member {string} [field] Header key.
* @member {string} [value] Header value.
*/
export interface MessageHeader {
field?: string;
value?: string;
}
/**
* @class
* Initializes a new instance of the Metadata class.
* @constructor
* Advanced use case content related to the message.
*
* @member {array} [headers] Email headers.
*/
export interface Metadata {
headers?: MessageHeader[];
}
/**
* @class
* Initializes a new instance of the Message class.
* @constructor
* @member {uuid} [id] Unique identifier for the message.
* @member {array} [from] The sender of the message.
* @member {array} [to] The message’s recipient.
* @member {array} [cc] Carbon-copied recipients for email messages.
* @member {array} [bcc] Blind carbon-copied recipients for email messages.
* @member {date} [received] The datetime that this message was received by
* Mailosaur.
* @member {string} [subject] The message’s subject.
* @member {object} [html] Message content that was sent in HTML format.
* @member {array} [html.links]
* @member {array} [html.images]
* @member {string} [html.body]
* @member {object} [text] Message content that was sent in plain text format.
* @member {array} [text.links]
* @member {array} [text.images]
* @member {string} [text.body]
* @member {array} [attachments] An array of attachment metadata for any
* attached files.
* @member {object} [metadata]
* @member {array} [metadata.headers] Email headers.
* @member {string} [server] Identifier for the server in which the message is
* located.
*/
export interface Message {
id?: string;
from?: MessageAddress[];
to?: MessageAddress[];
cc?: MessageAddress[];
bcc?: MessageAddress[];
received?: Date;
subject?: string;
html?: MessageContent;
text?: MessageContent;
attachments?: Attachment[];
metadata?: Metadata;
server?: string;
}
/**
* @class
* Initializes a new instance of the MessageSummary class.
* @constructor
* @member {uuid} id
* @member {string} [server]
* @member {array} [rcpt]
* @member {array} [from]
* @member {array} [to]
* @member {array} [cc]
* @member {array} [bcc]
* @member {date} [received]
* @member {string} [subject]
* @member {string} [summary]
* @member {number} [attachments]
*/
export interface MessageSummary {
id: string;
server?: string;
rcpt?: MessageAddress[];
from?: MessageAddress[];
to?: MessageAddress[];
cc?: MessageAddress[];
bcc?: MessageAddress[];
received?: Date;
subject?: string;
summary?: string;
attachments?: number;
}
/**
* @class
* Initializes a new instance of the MessageListResult class.
* @constructor
* The result of a message listing request.
*
* @member {array} [items] The individual summaries of each message forming the
* result. Summaries are returned sorted by received date, with the most
* recently-received messages appearing first.
*/
export interface MessageListResult {
items?: MessageSummary[];
}
/**
* @class
* Initializes a new instance of the SearchCriteria class.
* @constructor
* @member {string} [sentFrom] The full email address from which the target email
* was sent.
* @member {string} [sentTo] The full email address to which the target email
* was sent.
* @member {string} [subject] The value to seek within the target email's
* subject line.
* @member {string} [body] The value to seek within the target email's HTML or
* text body.
* @member {string} [match] If set to ALL (default), then only results that match all
* specified criteria will be returned. If set to ANY, results that match any of the
* specified criteria will be returned.
*/
export interface SearchCriteria {
sentFrom?: string;
sentTo?: string;
subject?: string;
body?: string;
match?: "ALL" | "ANY";
}
/**
* @class
* Initializes a new instance of the MessageCreateOptions class.
* @constructor
* @member {string} [to] The email address to which the email will be sent.
* @member {boolean} [send] If true, email will be sent upon creation.
* @member {string} [subject] The email subject line.
* @member {string} [text] The plain text body of the email. Note that only text or html can be supplied, not both.
* @member {string} [html] The HTML body of the email. Note that only text or html can be supplied, not both.
*/
export interface MessageCreateOptions {
to?: string;
send?: boolean;
subject?: string;
text?: string;
html?: string;
}
/**
* @class
* Initializes a new instance of the MessageForwardOptions class.
* @constructor
* @member {string} [to] The email address to which the email will be sent.
* @member {string} [text] Any additional plain text content to forward the email with. Note that only text or html can be supplied, not both.
* @member {string} [html] Any additional HTML content to forward the email with. Note that only html or text can be supplied, not both.
*/
export interface MessageForwardOptions {
to: string;
text?: string;
html?: string;
}
/**
* @class
* Initializes a new instance of the MessageReplyOptions class.
* @constructor
* @member {string} [text] Any additional plain text content to include in the reply. Note that only text or html can be supplied, not both.
* @member {string} [html] Any additional HTML content to include in the reply. Note that only html or text can be supplied, not both.
*/
export interface MessageReplyOptions {
text?: string;
html?: string;
}
/**
* @class
* Initializes a new instance of the Server class.
* @constructor
* @member {string} [id] Unique identifier for the server. Used as username for
* SMTP/POP3 authentication.
* @member {string} [name] A name used to identify the server.
* @member {array} [users] Users (excluding administrators) who have access to
* the server.
* @member {number} [messages] The number of messages currently in the server.
*/
export interface Server {
id?: string;
name?: string;
users?: string[];
messages?: number;
}
/**
* @class
* Initializes a new instance of the ServerListResult class.
* @constructor
* The result of a server listing request.
*
* @member {array} [items] The individual servers forming the result. Servers
* are returned sorted by creation date, with the most recently-created server
* appearing first.
*/
export interface ServerListResult {
items?: Server[];
}
/**
* @class
* Initializes a new instance of the ServerCreateOptions class.
* @constructor
* @member {string} [name] A name used to identify the server.
*/
export interface ServerCreateOptions {
name?: string;
}
export interface SearchOptions {
timeout?: number,
receivedAfter?: Date,
page?: number,
itemsPerPage?: number,
suppressError?: boolean
}
declare global {
namespace Cypress {
interface Chainable {
/**
* @summary List all servers
*
* Returns a list of your virtual SMTP servers. Servers are returned sorted in
* alphabetical order.
*
*/
mailosaurListServers(
): Cypress.Chainable<ServerListResult>;
mailosaurCreateServer(
options: ServerCreateOptions
): Cypress.Chainable<Server>;
mailosaurGetServer(
serverId: string
): Cypress.Chainable<Server>;
mailosaurGetServerPassword(
serverId: string
): Cypress.Chainable<string>;
mailosaurUpdateServer(
server: Server
): Cypress.Chainable<Server>;
mailosaurDeleteServer(
serverId: string
): Cypress.Chainable<null>;
mailosaurDeleteAllMessages(
serverId: string
): Cypress.Chainable<null>;
mailosaurListMessages(
serverId: string
): Cypress.Chainable<MessageListResult>;
mailosaurCreateMessage(
serverId: string,
options: MessageCreateOptions
): Cypress.Chainable<Message>;
mailosaurForwardMessage(
id: string,
options: MessageForwardOptions
): Cypress.Chainable<Message>;
mailosaurReplyMessage(
id: string,
options: MessageReplyOptions
): Cypress.Chainable<Message>;
mailosaurGetMessage(
serverId: string,
criteria: SearchCriteria,
options?: SearchOptions
): Cypress.Chainable<Message>;
mailosaurGetMessageById(
messageId: string
): Cypress.Chainable<Message>;
mailosaurSearchMessages(
serverId: string,
criteria: SearchCriteria,
options?: SearchOptions
): Cypress.Chainable<MessageListResult>;
mailosaurGetMessagesBySubject(
serverId: string,
subject: string
): Cypress.Chainable<MessageListResult>;
mailosaurGetMessagesByBody(
serverId: string,
body: string
): Cypress.Chainable<MessageListResult>;
mailosaurGetMessagesBySentFrom(
serverId: string,
sentFrom: string
): Cypress.Chainable<MessageListResult>;
mailosaurGetMessagesBySentTo(
serverId: string,
sentTo: string
): Cypress.Chainable<MessageListResult>;
mailosaurDownloadAttachment(
attachmentId: string
): Cypress.Chainable<Attachment>;
mailosaurDownloadMessage(
messageId: string
): Cypress.Chainable<string>;
mailosaurDeleteMessage(
messageId: string
): Cypress.Chainable<null>;
/**
* @summary Perform a spam test
*
* Perform spam testing on the specified email
*
* @param {string} messageId The identifier of the email to be analyzed.
*
* @returns {Chainable<SpamAnalysisResult>}
*/
mailosaurGetSpamAnalysis(
messageId: string
): Chainable<SpamAnalysisResult>;
mailosaurGenerateEmailAddress(
serverId: string
): Cypress.Chainable<string>;
}
}
}