node-ovh-ts/dist/handlers/EmailMxplan.d.ts

OVH API wrapper library for TypeScript

import { EmailMxplanAccountCapabilities } from '../models/EmailMxplanAccountCapabilities.js';
import { EmailMxplanAccountFullAccess } from '../models/EmailMxplanAccountFullAccess.js';
import { EmailMxplanService } from '../models/EmailMxplanService.js';
import { EmailMxplanAccountDiagnosis } from '../models/EmailMxplanAccountDiagnosis.js';
import { EmailMxplanAccountSendOnBehalfTo } from '../models/EmailMxplanAccountSendOnBehalfTo.js';
import { EmailProDisclaimerAttributeEnum } from '../models/EmailProDisclaimerAttributeEnum.js';
import { EmailProDisclaimer } from '../models/EmailProDisclaimer.js';
import { EmailMxplanAccountAlias } from '../models/EmailMxplanAccountAlias.js';
import { EmailMxplanServer } from '../models/EmailMxplanServer.js';
import { EmailMxplanAccountSendAs } from '../models/EmailMxplanAccountSendAs.js';
import { EmailMxplanAccount } from '../models/EmailMxplanAccount.js';
import { EmailProTask } from '../models/EmailProTask.js';
import { EmailMxplanExternalContact } from '../models/EmailMxplanExternalContact.js';
import { EmailMxplanDomain } from '../models/EmailMxplanDomain.js';
import OVHBase from '../ovh.js';
import '../models/EmailProServiceStateEnum.js';
import '../models/EmailProSpamAndVirusConfiguration.js';
import '../models/EmailMxplanServiceOfferEnum.js';
import '../models/EmailProServerStateEnum.js';
import '../models/EmailProObjectStateEnum.js';
import '../models/EmailProRenewPeriodEnum.js';
import '../models/EmailProMailingFilterEnum.js';
import '../models/EmailProTaskStatusEnum.js';
import '../models/EmailProTaskFunctionEnum.js';
import '../models/EmailProDomainTypeEnum.js';
import '../endpoints.js';

declare class EmailMxplanHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listMxplan: () => Promise<string[]>;
    /** Get this object properties */
    getMxplanByService: (service: string) => Promise<EmailMxplanService>;
    /** Alter this object properties */
    updateMxplanByService: (service: string, body: EmailMxplanService) => Promise<void>;
    /** Accounts associated to this mxplan service */
    getMxplanAccountByService: (service: string) => Promise<string[]>;
    /** Delete existing mailbox in mxplan server */
    deleteMxplanAccountByServiceAndEmail: (email: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanAccountByServiceAndEmail: (email: string, service: string) => Promise<EmailMxplanAccount>;
    /** Alter this object properties */
    updateMxplanAccountByServiceAndEmail: (email: string, service: string, body: EmailMxplanAccount) => Promise<void>;
    /** Aliases associated to this mailbox */
    getMxplanAccountAliasByServiceAndEmail: (email: string, service: string) => Promise<string[]>;
    /** Create new alias */
    createMxplanAccountAliasByServiceAndEmail: (email: string, service: string, body: {
        alias: string;
    }) => Promise<EmailProTask>;
    /** Delete existing alias */
    deleteMxplanAccountAliasByServiceAndEmailAndAlias: (alias: string, email: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanAccountAliasByServiceAndEmailAndAlias: (alias: string, email: string, service: string) => Promise<EmailMxplanAccountAlias>;
    /** Get available capabilities for this account */
    getMxplanAccountCapabilitiesByServiceAndEmail: (email: string, service: string) => Promise<EmailMxplanAccountCapabilities>;
    /** Change mailbox password */
    updateMxplanAccountPasswordByServiceAndEmail: (email: string, service: string, body: {
        password: string;
    }) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanAccountDiagnosticByServiceAndEmail: (email: string, service: string) => Promise<EmailMxplanAccountDiagnosis>;
    /** Create new diagnosis request */
    createMxplanAccountDiagnosticByServiceAndEmail: (email: string, service: string, body: {
        password: string;
    }) => Promise<EmailProTask>;
    /** Full access granted users for this mailbox */
    getMxplanAccountFullAccessByServiceAndEmail: (email: string, service: string) => Promise<number[]>;
    /** Allow full access to a user */
    postMxplanAccountFullAccessByServiceAndEmail: (email: string, service: string, body: {
        allowedAccountId: number;
    }) => Promise<EmailProTask>;
    /** Revoke full access */
    deleteMxplanAccountFullAccessByServiceAndEmailAndAllowedAccountId: (allowedAccountId: number, email: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanAccountFullAccessByServiceAndEmailAndAllowedAccountId: (allowedAccountId: number, email: string, service: string) => Promise<EmailMxplanAccountFullAccess>;
    /** Send as granted users for this mailbox */
    sendMxplanAccountAsByServiceAndEmail: (email: string, service: string) => Promise<number[]>;
    /** Allow another user to send mails from this mailbox */
    postMxplanAccountSendAsByServiceAndEmail: (email: string, service: string, body: {
        allowAccountId: number;
    }) => Promise<EmailProTask>;
    /** Delete allowed user for sendAs */
    deleteMxplanAccountSendAsByServiceAndEmailAndAllowedAccountId: (allowedAccountId: number, email: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanAccountSendAsByServiceAndEmailAndAllowedAccountId: (allowedAccountId: number, email: string, service: string) => Promise<EmailMxplanAccountSendAs>;
    /** SendOnBehalfTo granted users for this mailbox */
    sendMxplanAccountOnBehalfToByServiceAndEmail: (email: string, service: string) => Promise<number[]>;
    /** Allow another user to Send On Behalf To mails from this mailbox */
    postMxplanAccountSendOnBehalfToByServiceAndEmail: (email: string, service: string, body: {
        allowAccountId: number;
    }) => Promise<EmailProTask>;
    /** Delete allowed user for SendOnBehalfTo */
    deleteMxplanAccountSendOnBehalfToByServiceAndEmailAndAllowedAccountId: (allowedAccountId: number, email: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanAccountSendOnBehalfToByServiceAndEmailAndAllowedAccountId: (allowedAccountId: number, email: string, service: string) => Promise<EmailMxplanAccountSendOnBehalfTo>;
    /** Pending task for this mailbox */
    getMxplanAccountTaskByServiceAndEmail: (email: string, service: string) => Promise<number[]>;
    /** Get this object properties */
    getMxplanAccountTaskByServiceAndEmailAndId: (email: string, id: number, service: string) => Promise<EmailProTask>;
    /** Domains associated to this service */
    getMxplanDomainByService: (service: string) => Promise<string[]>;
    /** Get this object properties */
    getMxplanDomainByServiceAndDomainName: (domainName: string, service: string) => Promise<EmailMxplanDomain>;
    /** Alter this object properties */
    updateMxplanDomainByServiceAndDomainName: (domainName: string, service: string, body: EmailMxplanDomain) => Promise<void>;
    /** Delete existing organization disclaimer */
    deleteMxplanDomainDisclaimerByServiceAndDomainName: (domainName: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanDomainDisclaimerByServiceAndDomainName: (domainName: string, service: string) => Promise<EmailProDisclaimer>;
    /** Create organization disclaimer of each email */
    createMxplanDomainDisclaimerByServiceAndDomainName: (domainName: string, service: string, body: {
        content: string;
        outsideOnly?: boolean;
    }) => Promise<EmailProTask>;
    /** Alter this object properties */
    updateMxplanDomainDisclaimerByServiceAndDomainName: (domainName: string, service: string, body: EmailProDisclaimer) => Promise<void>;
    /** Get diclaimer attributes to substitute with Active Directory properties */
    getMxplanDomainDisclaimerAttributeByServiceAndDomainName: (domainName: string, service: string) => Promise<EmailProDisclaimerAttributeEnum[]>;
    /** External contacts for this service */
    getMxplanExternalContactByService: (service: string) => Promise<string[]>;
    /** create new external contact */
    createMxplanExternalContactByService: (service: string, body: {
        displayName?: string;
        externalEmailAddress: string;
        firstName?: string;
        hiddenFromGAL?: boolean;
        initials?: string;
        lastName?: string;
    }) => Promise<EmailProTask>;
    /** delete external contact */
    deleteMxplanExternalContactByServiceAndExternalEmailAddress: (externalEmailAddress: string, service: string) => Promise<EmailProTask>;
    /** Get this object properties */
    getMxplanExternalContactByServiceAndExternalEmailAddress: (externalEmailAddress: string, service: string) => Promise<EmailMxplanExternalContact>;
    /** Alter this object properties */
    updateMxplanExternalContactByServiceAndExternalEmailAddress: (externalEmailAddress: string, service: string, body: EmailMxplanExternalContact) => Promise<void>;
    /** Get this object properties */
    getMxplanServerByService: (service: string) => Promise<EmailMxplanServer>;
    /** Pending actions */
    getMxplanTaskByService: (service: string) => Promise<number[]>;
    /** Get this object properties */
    getMxplanTaskByServiceAndId: (id: number, service: string) => Promise<EmailProTask>;
    /** Update spam and virus flags on all active accounts */
    updateMxplanFlagsOnAllAccountsByService: (service: string) => Promise<void>;
}

export { EmailMxplanHandler };