@easybits.cloud/mailmask 0.4.4 → 0.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +10 -9
  2. package/dist/index.cjs +2 -1
  3. package/dist/index.d.cts +12 -1
  4. package/dist/index.d.ts +12 -1
  5. package/dist/index.js +2 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @easybits.cloud/mailmask
2
2
 
3
- Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email alias and forwarding API.
3
+ Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email address, mailbox and forwarding API.
4
4
 
5
5
  ## Install
6
6
 
@@ -19,29 +19,30 @@ const mm = new MailMask({ apiKey: "mk_..." });
19
19
  const domains = await mm.domains.list();
20
20
  const domainId = domains[0].id;
21
21
 
22
- // Create an alias — emails to hello@yourdomain.com forward to your inbox
23
- const alias = await mm.aliases.create(domainId, {
22
+ // Create an address — emails to hello@yourdomain.com forward to your inbox
23
+ const address = await mm.addresses.create(domainId, {
24
24
  alias: "hello",
25
25
  destinations: ["you@example.com"],
26
26
  });
27
27
 
28
28
  // Send an email (routed through MailMask for high deliverability)
29
29
  await mm.send.send(domainId, {
30
- from: "hello", // must be an active alias; defaults to `noreply`
30
+ from: "hello", // must be an active address; defaults to `noreply`
31
31
  fromName: "Acme", // optional display name: Acme <hello@yourdomain.com>
32
32
  to: "client@example.com",
33
33
  subject: "Welcome!",
34
34
  html: "<p>Thanks for signing up.</p>", // or `body` (plain text) / `markdown`
35
35
  });
36
36
 
37
- // List aliases for a domain
38
- const aliases = await mm.aliases.list(domainId);
37
+ // List addresses for a domain
38
+ const addresses = await mm.addresses.list(domainId);
39
39
 
40
40
  // Add a domain — returns the DNS records to configure (MX, TXT, DKIM, SPF)
41
41
  const { domain, dnsRecords } = await mm.domains.create("yourdomain.com");
42
42
 
43
- // An alias with an IMAP mailbox (activated domain): password is returned once
44
- const inbox = await mm.aliases.create(domainId, { alias: "sales", mailbox: true });
43
+ // An address with an IMAP mailbox (activated domain): password is returned once
44
+ const inbox = await mm.addresses.create(domainId, { alias: "sales", mailbox: true });
45
+ // `mm.aliases` still works: it is the same resource under its old name.
45
46
  console.log(inbox.buzon?.password, inbox.buzon?.imap);
46
47
  ```
47
48
 
@@ -79,7 +80,7 @@ Full API reference and examples: https://mailmask.studio/docs
79
80
 
80
81
  ## Links
81
82
 
82
- - [MailMask](https://mailmask.studio) — Email alias & forwarding service
83
+ - [MailMask](https://mailmask.studio) — Email addresses, mailboxes & forwarding on your domain
83
84
  - [EasyBits](https://easybits.cloud) — Cloud platform
84
85
  - [Fixter](https://fixter.org) — Development team
85
86
 
package/dist/index.cjs CHANGED
@@ -59,7 +59,8 @@ var MailMask = class {
59
59
  const doFetch = config.fetch ? config.fetch : fetch;
60
60
  const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts, doFetch);
61
61
  this.domains = new DomainsResource(req);
62
- this.aliases = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
62
+ this.addresses = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
63
+ this.aliases = this.addresses;
63
64
  this.rules = new RulesResource(req);
64
65
  this.logs = new LogsResource(req);
65
66
  this.send = new SendResource(req);
package/dist/index.d.cts CHANGED
@@ -47,6 +47,14 @@ interface DomainVerification {
47
47
  stale?: boolean;
48
48
  error?: string;
49
49
  }
50
+ /** Nombre público de `Alias` desde la 0.4.5. */
51
+ type Address = Alias;
52
+ /** Nombre público de `AliasCreated` desde la 0.4.5. */
53
+ type AddressCreated = AliasCreated;
54
+ /** Nombre público de `CreateAliasInput` desde la 0.4.5. */
55
+ type CreateAddressInput = CreateAliasInput;
56
+ /** Nombre público de `UpdateAliasInput` desde la 0.4.5. */
57
+ type UpdateAddressInput = UpdateAliasInput;
50
58
  interface Alias {
51
59
  alias: string;
52
60
  domainId: string;
@@ -663,6 +671,9 @@ declare class MailMask {
663
671
  private baseUrl;
664
672
  private apiKey;
665
673
  domains: DomainsResource;
674
+ /** Las direcciones del dominio (máscaras), con reenvío, buzón o ambos. */
675
+ addresses: AliasesResource;
676
+ /** @deprecated Usa `addresses`; es el mismo recurso y no se va a retirar. */
666
677
  aliases: AliasesResource;
667
678
  rules: RulesResource;
668
679
  logs: LogsResource;
@@ -1051,4 +1062,4 @@ interface WebhookSignatureHeaders {
1051
1062
  */
1052
1063
  declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
1053
1064
 
1054
- export { type AccountProfile, type Addon, type AddonsResponse, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
1065
+ export { type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
package/dist/index.d.ts CHANGED
@@ -47,6 +47,14 @@ interface DomainVerification {
47
47
  stale?: boolean;
48
48
  error?: string;
49
49
  }
50
+ /** Nombre público de `Alias` desde la 0.4.5. */
51
+ type Address = Alias;
52
+ /** Nombre público de `AliasCreated` desde la 0.4.5. */
53
+ type AddressCreated = AliasCreated;
54
+ /** Nombre público de `CreateAliasInput` desde la 0.4.5. */
55
+ type CreateAddressInput = CreateAliasInput;
56
+ /** Nombre público de `UpdateAliasInput` desde la 0.4.5. */
57
+ type UpdateAddressInput = UpdateAliasInput;
50
58
  interface Alias {
51
59
  alias: string;
52
60
  domainId: string;
@@ -663,6 +671,9 @@ declare class MailMask {
663
671
  private baseUrl;
664
672
  private apiKey;
665
673
  domains: DomainsResource;
674
+ /** Las direcciones del dominio (máscaras), con reenvío, buzón o ambos. */
675
+ addresses: AliasesResource;
676
+ /** @deprecated Usa `addresses`; es el mismo recurso y no se va a retirar. */
666
677
  aliases: AliasesResource;
667
678
  rules: RulesResource;
668
679
  logs: LogsResource;
@@ -1051,4 +1062,4 @@ interface WebhookSignatureHeaders {
1051
1062
  */
1052
1063
  declare function verifyWebhookSignature(secret: string, headers: WebhookSignatureHeaders, rawBody: string, toleranceMs?: number): Promise<boolean>;
1053
1064
 
1054
- export { type AccountProfile, type Addon, type AddonsResponse, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
1065
+ export { type AccountProfile, type Addon, type AddonsResponse, type Address, type AddressCreated, type Alias, type AliasCreated, type ApiKey, type AttachmentRef, type BillingStatus, type BulkJob, type BulkJobCreated, type BulkSendInput, type CannedReply, type CheckoutLink, type CreateAddressInput, type CreateAliasInput, type CreateRuleInput, type CreateWebhookInput, type DnsChangeResult, type DnsDelegation, type DnsImportResult, type DnsListResponse, type DnsPreset, type DnsRRSet, type DnsRRSetAnotado, type DnsRecord, type DnsRecordType, type DnsSetup, type DnsSetupRecord, type DnsZoneCreated, type DnsZoneState, type Domain, type DomainCreated, type DomainInvite, type DomainMember, type DomainRegistration, type DomainRegistrationCreated, type DomainSearchResult, type DomainVerification, type EmailLog, type InboxAttachment, type InboxComposeInput, type InboxConversation, type InboxConversationDetail, type InboxListOptions, type InboxMessage, type InboxNote, type InboxPage, type InboxReplyInput, type InboxStatus, type InboxUpdateInput, MailMask, type MailMaskConfig, MailMaskError, type MailboxCreated, type Order, type OrdersPage, type ReferralStats, type RenewalLink, type Rule, type RuleAction, type RuleField, type RuleMatch, type SendEmailInput, type SendOptions, type SmtpCredential, type SmtpCredentialCreated, type Suppression, type TldPrice, type TransferCheck, type TransferDnsInventory, type TransferRequirement, type UpdateAddressInput, type UpdateAliasInput, type UpdateRuleInput, type UpdateWebhookInput, type UploadAttachmentInput, type UploadedAttachment, type Webhook, type WebhookCreated, type WebhookDelivery, type WebhookEvent, type WebhookPayload, type WebhookSignatureHeaders, verifyWebhookSignature };
package/dist/index.js CHANGED
@@ -31,7 +31,8 @@ var MailMask = class {
31
31
  const doFetch = config.fetch ? config.fetch : fetch;
32
32
  const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts, doFetch);
33
33
  this.domains = new DomainsResource(req);
34
- this.aliases = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
34
+ this.addresses = new AliasesResource(req, (path) => requestRaw(this.baseUrl, this.apiKey, path, doFetch));
35
+ this.aliases = this.addresses;
35
36
  this.rules = new RulesResource(req);
36
37
  this.logs = new LogsResource(req);
37
38
  this.send = new SendResource(req);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easybits.cloud/mailmask",
3
- "version": "0.4.4",
3
+ "version": "0.4.5",
4
4
  "description": "Official SDK for the MailMask email alias/forwarding API",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",