mailgun.js 10.0.1 → 10.1.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [10.1.0](https://github.com/mailgun/mailgun.js/compare/v10.0.1...v10.1.0) (2024-01-31)
+
+
+### Features
+
+* Add proxy configuration to the client ([fa013f1](https://github.com/mailgun/mailgun.js/commits/fa013f1f49792d1e42b4e718b629514198393f4e))
+
+
+### Bug Fixes
+
+* **docs:** Add url param for EU infrastructure ([360b867](https://github.com/mailgun/mailgun.js/commits/360b867c03da6f70669e6bba0c3070fdd9f10885))
+
+
+### Other changes
+
+* Update readme ([3897e59](https://github.com/mailgun/mailgun.js/commits/3897e59554316994579960eb5f3ee7373b72f29d))
+
 ### [10.0.1](https://github.com/mailgun/mailgun.js/compare/v10.0.0...v10.0.1) (2024-01-26)
 
 

package/Classes/common/Request.d.ts

@@ -8,6 +8,7 @@ declare class Request {
     private headers;
     private formDataBuilder;
     private maxBodyLength;
+    private proxy;
     constructor(options: RequestOptions, formData: InputFormData);
     request(method: string, url: string, onCallOptions?: Record<string, unknown | Record<string, unknown>>): Promise<APIResponse>;
     private getResponseBody;

package/README.md

@@ -42,6 +42,8 @@ Next, require the module and instantiate a mailgun client by calling `new Mailgu
 
 NOTE: starting from version 3.0 you need to pass FormData (we need this to keep library universal). For node.js you can use `form-data` library.
 
+IMPORTANT: if you are using EU infrastructure, you need to also pass `url: 'https://api.eu.mailgun.net'` together with auth credentials as stated in [Mailgun docs](https://documentation.mailgun.com/en/latest/quickstart-sending.html#send-via-api)
+
 ### Imports
 Once the package is installed, you can import the library using `import` or `require` approach:
 
@@ -68,6 +70,29 @@ Primary accounts can make API calls on behalf of their subaccounts. [API documen
   // then, if you need to reset it back to the primary account:
   mg.resetSubaccount();
 ```
+
+### Proxy configuration
+By leveraging client configuration options, users can effortlessly establish proxy connections that align with their network requirements.
+Ex:
+```js
+  import * as FormData from 'form-data';
+  import Mailgun from 'mailgun.js';
+  const mailgun = new Mailgun(FormData);
+
+  const mg = mailgun.client({
+    username: 'api',
+    key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere',
+    proxy: {
+      protocol: 'https' // 'http' ,
+      host: '127.0.0.1', // use your proxy host here
+      port: 9000, // use your proxy port here
+      auth: { // may be omitted if proxy doesn't require authentication
+        username: 'user_name', // provide username
+        password: 'user_password' // provide password
+      }
+    },
+  });
+```
 ### Types imports
 Starting from version **9.0.0.** Types can be includes as named import:
 ```TS

package/Types/MailgunClient/MailgunClientOptions.d.ts

@@ -1,7 +1,9 @@
+import { AxiosProxyConfig } from 'axios';
 export type MailgunClientOptions = {
     username: string;
     key: string;
     url?: string;
     public_key?: string;
     timeout?: number;
+    proxy?: AxiosProxyConfig;
 };