-
Notifications
You must be signed in to change notification settings - Fork 37
/
AdminClient.js
226 lines (208 loc) · 8.26 KB
/
AdminClient.js
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
var defaults = require('./clientDefaults.js');
var merge = require('merge');
var querystring = require('querystring');
/**
* Description
* @class AdminClient
* @param {string} apiKey The **account-level** key used to access your Postmark Account and manage servers and signatures. This is _not_ the same as your **server key**.
* @param {ClientDetfaults} [options] The options used to create this client, if not specified, the postmark.defaults will be used.
*
* @return AdminClient
*/
function AdminClient(apiKey, options) {
if (!apiKey) {
throw ("You must provide your Postmark Account API token.");
}
this.options = merge({}, defaults, options);
this.options.apiKey = apiKey;
this.options.authorizationHeader = "X-Postmark-Account-Token";
this.processRequestWithBody = this.options.requestFactory(this.options);
}
AdminClient.prototype = {};
/**
* @private
* @param {} arg1
* @param {} arg2
* @return PostmarkCallback
*/
function coalesceCallback(arg1, arg2) {
var callback = arg2;
if (!callback && typeof(arg1) === 'function') {
callback = arg1;
}
return callback;
}
/**
* @private
* @memberOf AdminClient.prototype
* @method processRequestWithoutBody
* @param {string} path
* @param {string} type
* @param {object} query
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.processRequestWithoutBody = function(path, type, query, callback) {
if (query) {
path += '?' + querystring.stringify(query);
}
this.processRequestWithBody(path, type, null, callback);
}
/**
* Get a list of Sender Signatures associated with this account. By default,
* this method returns the first 100 signatures in your account.
*
* @memberOf AdminClient.prototype
* @method listSenderSignatures
* @param {object} [query] An optional filter to be used when retrieving the list of Sender Signatures.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.listSenderSignatures = function(query, callback) {
callback = coalesceCallback(query, callback);
query = merge({
count: 100,
offset: 0
}, query);
this.processRequestWithoutBody('/senders', 'GET', query, callback);
};
/**
* Get a single Sender Signature by id.
*
* @memberOf AdminClient.prototype
* @method getSenderSignature
* @param {number} id The ID for the Sender Signature you wish to retrieve.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.getSenderSignature = function(id, callback) {
this.processRequestWithoutBody('/senders/' + id, 'GET', null, callback);
};
/**
* Create a Sender Signature.
*
* @memberOf AdminClient.prototype
* @method createSenderSignature
* @param {object} options The configuration options for the Sender Signature to be created.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.createSenderSignature = function(options, callback) {
this.processRequestWithBody('/senders/', 'POST', options, callback);
};
/**
* Modify an existing Sender Signature.
*
* @memberOf AdminClient.prototype
* @method editSenderSignature
* @param {number} id The ID of the Sender Signature to be modified.
* @param {object} options The updated options for the Sender Sinature to be modified.
* @param {postmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.editSenderSignature = function(id, options, callback) {
this.processRequestWithBody('/senders/' + id, 'PUT', options, callback);
};
/**
* Delete a Sender Signature.
*
* @memberOf AdminClient.prototype
* @method deleteSenderSignature
* @param {number} id The ID for the Sender Signature you wish to delete.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.deleteSenderSignature = function(id, callback) {
this.processRequestWithoutBody('/senders/' + id, 'DELETE', null, callback);
};
/**
* Request that a new confirmation email be sent to the email address associated with a Sender Signature.
*
* @memberOf AdminClient.prototype
* @method resendSenderSignatureConfirmation
* @param {number} id The ID for the Sender Signature for which you wish to have a confirmation re-sent.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.resendSenderSignatureConfirmation = function(id, callback) {
this.processRequestWithBody('/senders/' + id + '/resend', 'POST', null, callback);
};
/**
* Request that the SPF records for Sender Signature be verified.
*
* @memberOf AdminClient.prototype
* @method verifySenderSignatureSPF
* @param {number} id The ID for the Sender Signature for which you wish to have the SPI verified.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.verifySenderSignatureSPF = function(id, callback) {
this.processRequestWithBody('/senders/' + id + '/verifyspf', 'POST', null, callback);
};
/**
* Request a new DKIM for the specified Sender Signature.
*
* @memberOf AdminClient.prototype
* @method requestNewDKIMForSenderSignature
* @param {number} id The ID for the Sender Signature for which you wish have a new DKIM issued.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.requestNewDKIMForSenderSignature = function(id, callback) {
this.processRequestWithBody('/senders/' + id + '/requestnewdkim', 'POST', null, callback);
};
/**
* Retrieve information for a specific Server.
*
* @memberOf AdminClient.prototype
* @method getServer
* @param {number} id The ID of the Server you wish to access.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.getServer = function(id, callback) {
this.processRequestWithoutBody('/servers/' + id, 'GET', null, callback);
};
/**
* Create a new Server from which you may send and recieve email.
*
* @memberOf AdminClient.prototype
* @method createServer
* @param {object} options The configuration options to be used when creating the new Server.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.createServer = function(options, callback) {
this.processRequestWithBody('/servers/', 'POST', options, callback);
};
/**
* Modify an existing Server.
*
* @memberOf AdminClient.prototype
* @method editServer
* @param {number} id The ID of the Server you wish to edit.
* @param {object} options The options you wish to modify on the Server.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.editServer = function(id, options, callback) {
this.processRequestWithBody('/servers/' + id, 'PUT', options, callback);
};
/**
* Delete a Server with the specified ID.
*
* NOTE: Because this is a dangerous operation and can cause serious problems in your account, you must request that this API be enabled for your account from **[email protected]**
*
* @memberOf AdminClient.prototype
* @method deleteServer
* @param {number} id The ID of the Server you wish to delete.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.deleteServer = function(id, callback) {
this.processRequestWithoutBody('/servers/' + id, 'DELETE', null, callback);
};
/**
* Get a list of Servers associated with this account. By default, the first 100 Servers associated with the account are used.
*
* @memberOf AdminClient.prototype
* @method listServers
* @param {number} [query] An optional filter to use when retrieving the list of Servers.
* @param {PostmarkCallback} callback A standard callback that is called when the API request completes.
*/
AdminClient.prototype.listServers = function(query, callback) {
callback = coalesceCallback(query, callback);
query = merge({
count: 100,
offset: 0
}, query);
this.processRequestWithoutBody('/servers/', 'GET', query, callback);
};
module.exports = AdminClient;