MailManager

import { MailManager } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/mailmanager.ts?docs=full";

class MailManager {

constructor(apiFactory: client.ApiFactory);

async createAddonInstance(params: CreateAddonInstanceRequest, opts?: client.RequestOptions): Promise<CreateAddonInstanceResponse>;

async createAddonSubscription(params: CreateAddonSubscriptionRequest, opts?: client.RequestOptions): Promise<CreateAddonSubscriptionResponse>;

async createArchive(params: CreateArchiveRequest, opts?: client.RequestOptions): Promise<CreateArchiveResponse>;

async createIngressPoint(params: CreateIngressPointRequest, opts?: client.RequestOptions): Promise<CreateIngressPointResponse>;

async createRelay(params: CreateRelayRequest, opts?: client.RequestOptions): Promise<CreateRelayResponse>;

async createRuleSet(params: CreateRuleSetRequest, opts?: client.RequestOptions): Promise<CreateRuleSetResponse>;

async createTrafficPolicy(params: CreateTrafficPolicyRequest, opts?: client.RequestOptions): Promise<CreateTrafficPolicyResponse>;

async deleteAddonInstance(params: DeleteAddonInstanceRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAddonSubscription(params: DeleteAddonSubscriptionRequest, opts?: client.RequestOptions): Promise<void>;

async deleteArchive(params: DeleteArchiveRequest, opts?: client.RequestOptions): Promise<void>;

async deleteIngressPoint(params: DeleteIngressPointRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRelay(params: DeleteRelayRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRuleSet(params: DeleteRuleSetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTrafficPolicy(params: DeleteTrafficPolicyRequest, opts?: client.RequestOptions): Promise<void>;

async getAddonInstance(params: GetAddonInstanceRequest, opts?: client.RequestOptions): Promise<GetAddonInstanceResponse>;

async getAddonSubscription(params: GetAddonSubscriptionRequest, opts?: client.RequestOptions): Promise<GetAddonSubscriptionResponse>;

async getArchive(params: GetArchiveRequest, opts?: client.RequestOptions): Promise<GetArchiveResponse>;

async getArchiveExport(params: GetArchiveExportRequest, opts?: client.RequestOptions): Promise<GetArchiveExportResponse>;

async getArchiveMessage(params: GetArchiveMessageRequest, opts?: client.RequestOptions): Promise<GetArchiveMessageResponse>;

async getArchiveMessageContent(params: GetArchiveMessageContentRequest, opts?: client.RequestOptions): Promise<GetArchiveMessageContentResponse>;

async getArchiveSearch(params: GetArchiveSearchRequest, opts?: client.RequestOptions): Promise<GetArchiveSearchResponse>;

async getArchiveSearchResults(params: GetArchiveSearchResultsRequest, opts?: client.RequestOptions): Promise<GetArchiveSearchResultsResponse>;

async getIngressPoint(params: GetIngressPointRequest, opts?: client.RequestOptions): Promise<GetIngressPointResponse>;

async getRelay(params: GetRelayRequest, opts?: client.RequestOptions): Promise<GetRelayResponse>;

async getRuleSet(params: GetRuleSetRequest, opts?: client.RequestOptions): Promise<GetRuleSetResponse>;

async getTrafficPolicy(params: GetTrafficPolicyRequest, opts?: client.RequestOptions): Promise<GetTrafficPolicyResponse>;

async listAddonInstances(params?: ListAddonInstancesRequest, opts?: client.RequestOptions): Promise<ListAddonInstancesResponse>;

async listAddonSubscriptions(params?: ListAddonSubscriptionsRequest, opts?: client.RequestOptions): Promise<ListAddonSubscriptionsResponse>;

async listArchiveExports(params: ListArchiveExportsRequest, opts?: client.RequestOptions): Promise<ListArchiveExportsResponse>;

async listArchives(params?: ListArchivesRequest, opts?: client.RequestOptions): Promise<ListArchivesResponse>;

async listArchiveSearches(params: ListArchiveSearchesRequest, opts?: client.RequestOptions): Promise<ListArchiveSearchesResponse>;

async listIngressPoints(params?: ListIngressPointsRequest, opts?: client.RequestOptions): Promise<ListIngressPointsResponse>;

async listRelays(params?: ListRelaysRequest, opts?: client.RequestOptions): Promise<ListRelaysResponse>;

async listRuleSets(params?: ListRuleSetsRequest, opts?: client.RequestOptions): Promise<ListRuleSetsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTrafficPolicies(params?: ListTrafficPoliciesRequest, opts?: client.RequestOptions): Promise<ListTrafficPoliciesResponse>;

async startArchiveExport(params: StartArchiveExportRequest, opts?: client.RequestOptions): Promise<StartArchiveExportResponse>;

async startArchiveSearch(params: StartArchiveSearchRequest, opts?: client.RequestOptions): Promise<StartArchiveSearchResponse>;

async stopArchiveExport(params: StopArchiveExportRequest, opts?: client.RequestOptions): Promise<void>;

async stopArchiveSearch(params: StopArchiveSearchRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateArchive(params: UpdateArchiveRequest, opts?: client.RequestOptions): Promise<void>;

async updateIngressPoint(params: UpdateIngressPointRequest, opts?: client.RequestOptions): Promise<void>;

async updateRelay(params: UpdateRelayRequest, opts?: client.RequestOptions): Promise<void>;

async updateRuleSet(params: UpdateRuleSetRequest, opts?: client.RequestOptions): Promise<void>;

async updateTrafficPolicy(params: UpdateTrafficPolicyRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new MailManager(apiFactory: client.ApiFactory)

[src]

§Methods

createAddonInstance(params: CreateAddonInstanceRequest, opts?: client.RequestOptions): Promise<CreateAddonInstanceResponse>

[src]

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

createAddonSubscription(params: CreateAddonSubscriptionRequest, opts?: client.RequestOptions): Promise<CreateAddonSubscriptionResponse>

[src]

Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.

createArchive(params: CreateArchiveRequest, opts?: client.RequestOptions): Promise<CreateArchiveResponse>

[src]

Creates a new email archive resource for storing and retaining emails.

createIngressPoint(params: CreateIngressPointRequest, opts?: client.RequestOptions): Promise<CreateIngressPointResponse>

[src]

Provision a new ingress endpoint resource.

createRelay(params: CreateRelayRequest, opts?: client.RequestOptions): Promise<CreateRelayResponse>

[src]

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

createRuleSet(params: CreateRuleSetRequest, opts?: client.RequestOptions): Promise<CreateRuleSetResponse>

[src]

Provision a new rule set.

createTrafficPolicy(params: CreateTrafficPolicyRequest, opts?: client.RequestOptions): Promise<CreateTrafficPolicyResponse>

[src]

Provision a new traffic policy resource.

deleteAddonInstance(params: DeleteAddonInstanceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an Add On instance.

deleteAddonSubscription(params: DeleteAddonSubscriptionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an Add On subscription.

deleteArchive(params: DeleteArchiveRequest, opts?: client.RequestOptions): Promise<void>

[src]

Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.

deleteIngressPoint(params: DeleteIngressPointRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete an ingress endpoint resource.

deleteRelay(params: DeleteRelayRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an existing relay resource.

deleteRuleSet(params: DeleteRuleSetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete a rule set.

deleteTrafficPolicy(params: DeleteTrafficPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete a traffic policy resource.

getAddonInstance(params: GetAddonInstanceRequest, opts?: client.RequestOptions): Promise<GetAddonInstanceResponse>

[src]

Gets detailed information about an Add On instance.

getAddonSubscription(params: GetAddonSubscriptionRequest, opts?: client.RequestOptions): Promise<GetAddonSubscriptionResponse>

[src]

Gets detailed information about an Add On subscription.

getArchive(params: GetArchiveRequest, opts?: client.RequestOptions): Promise<GetArchiveResponse>

[src]

Retrieves the full details and current state of a specified email archive.

getArchiveExport(params: GetArchiveExportRequest, opts?: client.RequestOptions): Promise<GetArchiveExportResponse>

[src]

Retrieves the details and current status of a specific email archive export job.

getArchiveMessage(params: GetArchiveMessageRequest, opts?: client.RequestOptions): Promise<GetArchiveMessageResponse>

[src]

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

getArchiveMessageContent(params: GetArchiveMessageContentRequest, opts?: client.RequestOptions): Promise<GetArchiveMessageContentResponse>

[src]

Returns the textual content of a specific email message stored in the archive. Attachments are not included.

getArchiveSearch(params: GetArchiveSearchRequest, opts?: client.RequestOptions): Promise<GetArchiveSearchResponse>

[src]

Retrieves the details and current status of a specific email archive search job.

getArchiveSearchResults(params: GetArchiveSearchResultsRequest, opts?: client.RequestOptions): Promise<GetArchiveSearchResultsResponse>

[src]

Returns the results of a completed email archive search job.

getIngressPoint(params: GetIngressPointRequest, opts?: client.RequestOptions): Promise<GetIngressPointResponse>

[src]

Fetch ingress endpoint resource attributes.

getRelay(params: GetRelayRequest, opts?: client.RequestOptions): Promise<GetRelayResponse>

[src]

Fetch the relay resource and it's attributes.

getRuleSet(params: GetRuleSetRequest, opts?: client.RequestOptions): Promise<GetRuleSetResponse>

[src]

Fetch attributes of a rule set.

getTrafficPolicy(params: GetTrafficPolicyRequest, opts?: client.RequestOptions): Promise<GetTrafficPolicyResponse>

[src]

Fetch attributes of a traffic policy resource.

listAddonInstances(params?: ListAddonInstancesRequest, opts?: client.RequestOptions): Promise<ListAddonInstancesResponse>

[src]

Lists all Add On instances in your account.

listAddonSubscriptions(params?: ListAddonSubscriptionsRequest, opts?: client.RequestOptions): Promise<ListAddonSubscriptionsResponse>

[src]

Lists all Add On subscriptions in your account.

listArchiveExports(params: ListArchiveExportsRequest, opts?: client.RequestOptions): Promise<ListArchiveExportsResponse>

[src]

Returns a list of email archive export jobs.

listArchives(params?: ListArchivesRequest, opts?: client.RequestOptions): Promise<ListArchivesResponse>

[src]

Returns a list of all email archives in your account.

listArchiveSearches(params: ListArchiveSearchesRequest, opts?: client.RequestOptions): Promise<ListArchiveSearchesResponse>

[src]

Returns a list of email archive search jobs.

listIngressPoints(params?: ListIngressPointsRequest, opts?: client.RequestOptions): Promise<ListIngressPointsResponse>

[src]

List all ingress endpoint resources.

listRelays(params?: ListRelaysRequest, opts?: client.RequestOptions): Promise<ListRelaysResponse>

[src]

Lists all the existing relay resources.

listRuleSets(params?: ListRuleSetsRequest, opts?: client.RequestOptions): Promise<ListRuleSetsResponse>

[src]

List rule sets for this account.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Retrieves the list of tags (keys and values) assigned to the resource.

listTrafficPolicies(params?: ListTrafficPoliciesRequest, opts?: client.RequestOptions): Promise<ListTrafficPoliciesResponse>

[src]

List traffic policy resources.

startArchiveExport(params: StartArchiveExportRequest, opts?: client.RequestOptions): Promise<StartArchiveExportResponse>

[src]

Initiates an export of emails from the specified archive.

startArchiveSearch(params: StartArchiveSearchRequest, opts?: client.RequestOptions): Promise<StartArchiveSearchResponse>

[src]

Initiates a search across emails in the specified archive.

stopArchiveExport(params: StopArchiveExportRequest, opts?: client.RequestOptions): Promise<void>

[src]

Stops an in-progress export of emails from an archive.

stopArchiveSearch(params: StopArchiveSearchRequest, opts?: client.RequestOptions): Promise<void>

[src]

Stops an in-progress archive search job.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags (keys and values) to a specified resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Remove one or more tags (keys and values) from a specified resource.

updateArchive(params: UpdateArchiveRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the attributes of an existing email archive.

updateIngressPoint(params: UpdateIngressPointRequest, opts?: client.RequestOptions): Promise<void>

[src]

Update attributes of a provisioned ingress endpoint resource.

updateRelay(params: UpdateRelayRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the attributes of an existing relay resource.

updateRuleSet(params: UpdateRuleSetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Update attributes of an already provisioned rule set.

updateTrafficPolicy(params: UpdateTrafficPolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Update attributes of an already provisioned traffic policy resource.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]