@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSMailManager extends Object implements AWSMailManager
AWSMailManager
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateAddonInstanceResult |
createAddonInstance(CreateAddonInstanceRequest request)
Creates an Add On instance for the subscription indicated in the request.
|
CreateAddonSubscriptionResult |
createAddonSubscription(CreateAddonSubscriptionRequest request)
Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing.
|
CreateArchiveResult |
createArchive(CreateArchiveRequest request)
Creates a new email archive resource for storing and retaining emails.
|
CreateIngressPointResult |
createIngressPoint(CreateIngressPointRequest request)
Provision a new ingress endpoint resource.
|
CreateRelayResult |
createRelay(CreateRelayRequest request)
Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
|
CreateRuleSetResult |
createRuleSet(CreateRuleSetRequest request)
Provision a new rule set.
|
CreateTrafficPolicyResult |
createTrafficPolicy(CreateTrafficPolicyRequest request)
Provision a new traffic policy resource.
|
DeleteAddonInstanceResult |
deleteAddonInstance(DeleteAddonInstanceRequest request)
Deletes an Add On instance.
|
DeleteAddonSubscriptionResult |
deleteAddonSubscription(DeleteAddonSubscriptionRequest request)
Deletes an Add On subscription.
|
DeleteArchiveResult |
deleteArchive(DeleteArchiveRequest request)
Initiates deletion of an email archive.
|
DeleteIngressPointResult |
deleteIngressPoint(DeleteIngressPointRequest request)
Delete an ingress endpoint resource.
|
DeleteRelayResult |
deleteRelay(DeleteRelayRequest request)
Deletes an existing relay resource.
|
DeleteRuleSetResult |
deleteRuleSet(DeleteRuleSetRequest request)
Delete a rule set.
|
DeleteTrafficPolicyResult |
deleteTrafficPolicy(DeleteTrafficPolicyRequest request)
Delete a traffic policy resource.
|
GetAddonInstanceResult |
getAddonInstance(GetAddonInstanceRequest request)
Gets detailed information about an Add On instance.
|
GetAddonSubscriptionResult |
getAddonSubscription(GetAddonSubscriptionRequest request)
Gets detailed information about an Add On subscription.
|
GetArchiveResult |
getArchive(GetArchiveRequest request)
Retrieves the full details and current state of a specified email archive.
|
GetArchiveExportResult |
getArchiveExport(GetArchiveExportRequest request)
Retrieves the details and current status of a specific email archive export job.
|
GetArchiveMessageResult |
getArchiveMessage(GetArchiveMessageRequest request)
Returns a pre-signed URL that provides temporary download access to the specific email message stored in the
archive.
|
GetArchiveMessageContentResult |
getArchiveMessageContent(GetArchiveMessageContentRequest request)
Returns the textual content of a specific email message stored in the archive.
|
GetArchiveSearchResult |
getArchiveSearch(GetArchiveSearchRequest request)
Retrieves the details and current status of a specific email archive search job.
|
GetArchiveSearchResultsResult |
getArchiveSearchResults(GetArchiveSearchResultsRequest request)
Returns the results of a completed email archive search job.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetIngressPointResult |
getIngressPoint(GetIngressPointRequest request)
Fetch ingress endpoint resource attributes.
|
GetRelayResult |
getRelay(GetRelayRequest request)
Fetch the relay resource and it's attributes.
|
GetRuleSetResult |
getRuleSet(GetRuleSetRequest request)
Fetch attributes of a rule set.
|
GetTrafficPolicyResult |
getTrafficPolicy(GetTrafficPolicyRequest request)
Fetch attributes of a traffic policy resource.
|
ListAddonInstancesResult |
listAddonInstances(ListAddonInstancesRequest request)
Lists all Add On instances in your account.
|
ListAddonSubscriptionsResult |
listAddonSubscriptions(ListAddonSubscriptionsRequest request)
Lists all Add On subscriptions in your account.
|
ListArchiveExportsResult |
listArchiveExports(ListArchiveExportsRequest request)
Returns a list of email archive export jobs.
|
ListArchivesResult |
listArchives(ListArchivesRequest request)
Returns a list of all email archives in your account.
|
ListArchiveSearchesResult |
listArchiveSearches(ListArchiveSearchesRequest request)
Returns a list of email archive search jobs.
|
ListIngressPointsResult |
listIngressPoints(ListIngressPointsRequest request)
List all ingress endpoint resources.
|
ListRelaysResult |
listRelays(ListRelaysRequest request)
Lists all the existing relay resources.
|
ListRuleSetsResult |
listRuleSets(ListRuleSetsRequest request)
List rule sets for this account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags (keys and values) assigned to the resource.
|
ListTrafficPoliciesResult |
listTrafficPolicies(ListTrafficPoliciesRequest request)
List traffic policy resources.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartArchiveExportResult |
startArchiveExport(StartArchiveExportRequest request)
Initiates an export of emails from the specified archive.
|
StartArchiveSearchResult |
startArchiveSearch(StartArchiveSearchRequest request)
Initiates a search across emails in the specified archive.
|
StopArchiveExportResult |
stopArchiveExport(StopArchiveExportRequest request)
Stops an in-progress export of emails from an archive.
|
StopArchiveSearchResult |
stopArchiveSearch(StopArchiveSearchRequest request)
Stops an in-progress archive search job.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags (keys and values) to a specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Remove one or more tags (keys and values) from a specified resource.
|
UpdateArchiveResult |
updateArchive(UpdateArchiveRequest request)
Updates the attributes of an existing email archive.
|
UpdateIngressPointResult |
updateIngressPoint(UpdateIngressPointRequest request)
Update attributes of a provisioned ingress endpoint resource.
|
UpdateRelayResult |
updateRelay(UpdateRelayRequest request)
Updates the attributes of an existing relay resource.
|
UpdateRuleSetResult |
updateRuleSet(UpdateRuleSetRequest request)
>Update attributes of an already provisioned rule set.
|
UpdateTrafficPolicyResult |
updateTrafficPolicy(UpdateTrafficPolicyRequest request)
Update attributes of an already provisioned traffic policy resource.
|
public CreateAddonInstanceResult createAddonInstance(CreateAddonInstanceRequest request)
AWSMailManager
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.
createAddonInstance
in interface AWSMailManager
public CreateAddonSubscriptionResult createAddonSubscription(CreateAddonSubscriptionRequest request)
AWSMailManager
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.
createAddonSubscription
in interface AWSMailManager
public CreateArchiveResult createArchive(CreateArchiveRequest request)
AWSMailManager
Creates a new email archive resource for storing and retaining emails.
createArchive
in interface AWSMailManager
request
- The request to create a new email archive.public CreateIngressPointResult createIngressPoint(CreateIngressPointRequest request)
AWSMailManager
Provision a new ingress endpoint resource.
createIngressPoint
in interface AWSMailManager
public CreateRelayResult createRelay(CreateRelayRequest request)
AWSMailManager
Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
createRelay
in interface AWSMailManager
public CreateRuleSetResult createRuleSet(CreateRuleSetRequest request)
AWSMailManager
Provision a new rule set.
createRuleSet
in interface AWSMailManager
public CreateTrafficPolicyResult createTrafficPolicy(CreateTrafficPolicyRequest request)
AWSMailManager
Provision a new traffic policy resource.
createTrafficPolicy
in interface AWSMailManager
public DeleteAddonInstanceResult deleteAddonInstance(DeleteAddonInstanceRequest request)
AWSMailManager
Deletes an Add On instance.
deleteAddonInstance
in interface AWSMailManager
public DeleteAddonSubscriptionResult deleteAddonSubscription(DeleteAddonSubscriptionRequest request)
AWSMailManager
Deletes an Add On subscription.
deleteAddonSubscription
in interface AWSMailManager
public DeleteArchiveResult deleteArchive(DeleteArchiveRequest request)
AWSMailManager
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.
deleteArchive
in interface AWSMailManager
request
- The request to initiate deletion of an email archive.public DeleteIngressPointResult deleteIngressPoint(DeleteIngressPointRequest request)
AWSMailManager
Delete an ingress endpoint resource.
deleteIngressPoint
in interface AWSMailManager
public DeleteRelayResult deleteRelay(DeleteRelayRequest request)
AWSMailManager
Deletes an existing relay resource.
deleteRelay
in interface AWSMailManager
public DeleteRuleSetResult deleteRuleSet(DeleteRuleSetRequest request)
AWSMailManager
Delete a rule set.
deleteRuleSet
in interface AWSMailManager
public DeleteTrafficPolicyResult deleteTrafficPolicy(DeleteTrafficPolicyRequest request)
AWSMailManager
Delete a traffic policy resource.
deleteTrafficPolicy
in interface AWSMailManager
public GetAddonInstanceResult getAddonInstance(GetAddonInstanceRequest request)
AWSMailManager
Gets detailed information about an Add On instance.
getAddonInstance
in interface AWSMailManager
public GetAddonSubscriptionResult getAddonSubscription(GetAddonSubscriptionRequest request)
AWSMailManager
Gets detailed information about an Add On subscription.
getAddonSubscription
in interface AWSMailManager
public GetArchiveResult getArchive(GetArchiveRequest request)
AWSMailManager
Retrieves the full details and current state of a specified email archive.
getArchive
in interface AWSMailManager
request
- The request to retrieve details of an email archive.public GetArchiveExportResult getArchiveExport(GetArchiveExportRequest request)
AWSMailManager
Retrieves the details and current status of a specific email archive export job.
getArchiveExport
in interface AWSMailManager
request
- The request to retrieve details of a specific archive export job.public GetArchiveMessageResult getArchiveMessage(GetArchiveMessageRequest request)
AWSMailManager
Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
getArchiveMessage
in interface AWSMailManager
request
- The request to get details of a specific email message stored in an archive.public GetArchiveMessageContentResult getArchiveMessageContent(GetArchiveMessageContentRequest request)
AWSMailManager
Returns the textual content of a specific email message stored in the archive. Attachments are not included.
getArchiveMessageContent
in interface AWSMailManager
request
- The request to get the textual content of a specific email message stored in an archive.public GetArchiveSearchResult getArchiveSearch(GetArchiveSearchRequest request)
AWSMailManager
Retrieves the details and current status of a specific email archive search job.
getArchiveSearch
in interface AWSMailManager
request
- The request to retrieve details of a specific archive search job.public GetArchiveSearchResultsResult getArchiveSearchResults(GetArchiveSearchResultsRequest request)
AWSMailManager
Returns the results of a completed email archive search job.
getArchiveSearchResults
in interface AWSMailManager
request
- The request to retrieve results from a completed archive search job.public GetIngressPointResult getIngressPoint(GetIngressPointRequest request)
AWSMailManager
Fetch ingress endpoint resource attributes.
getIngressPoint
in interface AWSMailManager
public GetRelayResult getRelay(GetRelayRequest request)
AWSMailManager
Fetch the relay resource and it's attributes.
getRelay
in interface AWSMailManager
public GetRuleSetResult getRuleSet(GetRuleSetRequest request)
AWSMailManager
Fetch attributes of a rule set.
getRuleSet
in interface AWSMailManager
public GetTrafficPolicyResult getTrafficPolicy(GetTrafficPolicyRequest request)
AWSMailManager
Fetch attributes of a traffic policy resource.
getTrafficPolicy
in interface AWSMailManager
public ListAddonInstancesResult listAddonInstances(ListAddonInstancesRequest request)
AWSMailManager
Lists all Add On instances in your account.
listAddonInstances
in interface AWSMailManager
public ListAddonSubscriptionsResult listAddonSubscriptions(ListAddonSubscriptionsRequest request)
AWSMailManager
Lists all Add On subscriptions in your account.
listAddonSubscriptions
in interface AWSMailManager
public ListArchiveExportsResult listArchiveExports(ListArchiveExportsRequest request)
AWSMailManager
Returns a list of email archive export jobs.
listArchiveExports
in interface AWSMailManager
request
- The request to list archive export jobs in your account.public ListArchiveSearchesResult listArchiveSearches(ListArchiveSearchesRequest request)
AWSMailManager
Returns a list of email archive search jobs.
listArchiveSearches
in interface AWSMailManager
request
- The request to list archive search jobs in your account.public ListArchivesResult listArchives(ListArchivesRequest request)
AWSMailManager
Returns a list of all email archives in your account.
listArchives
in interface AWSMailManager
request
- The request to list email archives in your account.public ListIngressPointsResult listIngressPoints(ListIngressPointsRequest request)
AWSMailManager
List all ingress endpoint resources.
listIngressPoints
in interface AWSMailManager
public ListRelaysResult listRelays(ListRelaysRequest request)
AWSMailManager
Lists all the existing relay resources.
listRelays
in interface AWSMailManager
public ListRuleSetsResult listRuleSets(ListRuleSetsRequest request)
AWSMailManager
List rule sets for this account.
listRuleSets
in interface AWSMailManager
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSMailManager
Retrieves the list of tags (keys and values) assigned to the resource.
listTagsForResource
in interface AWSMailManager
public ListTrafficPoliciesResult listTrafficPolicies(ListTrafficPoliciesRequest request)
AWSMailManager
List traffic policy resources.
listTrafficPolicies
in interface AWSMailManager
public StartArchiveExportResult startArchiveExport(StartArchiveExportRequest request)
AWSMailManager
Initiates an export of emails from the specified archive.
startArchiveExport
in interface AWSMailManager
request
- The request to initiate an export of emails from an archive.public StartArchiveSearchResult startArchiveSearch(StartArchiveSearchRequest request)
AWSMailManager
Initiates a search across emails in the specified archive.
startArchiveSearch
in interface AWSMailManager
request
- The request to initiate a search across emails in an archive.public StopArchiveExportResult stopArchiveExport(StopArchiveExportRequest request)
AWSMailManager
Stops an in-progress export of emails from an archive.
stopArchiveExport
in interface AWSMailManager
request
- The request to stop an in-progress archive export job.public StopArchiveSearchResult stopArchiveSearch(StopArchiveSearchRequest request)
AWSMailManager
Stops an in-progress archive search job.
stopArchiveSearch
in interface AWSMailManager
request
- The request to stop an in-progress archive search job.public TagResourceResult tagResource(TagResourceRequest request)
AWSMailManager
Adds one or more tags (keys and values) to a specified resource.
tagResource
in interface AWSMailManager
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSMailManager
Remove one or more tags (keys and values) from a specified resource.
untagResource
in interface AWSMailManager
public UpdateArchiveResult updateArchive(UpdateArchiveRequest request)
AWSMailManager
Updates the attributes of an existing email archive.
updateArchive
in interface AWSMailManager
request
- The request to update properties of an existing email archive.public UpdateIngressPointResult updateIngressPoint(UpdateIngressPointRequest request)
AWSMailManager
Update attributes of a provisioned ingress endpoint resource.
updateIngressPoint
in interface AWSMailManager
public UpdateRelayResult updateRelay(UpdateRelayRequest request)
AWSMailManager
Updates the attributes of an existing relay resource.
updateRelay
in interface AWSMailManager
public UpdateRuleSetResult updateRuleSet(UpdateRuleSetRequest request)
AWSMailManager
>Update attributes of an already provisioned rule set.
updateRuleSet
in interface AWSMailManager
public UpdateTrafficPolicyResult updateTrafficPolicy(UpdateTrafficPolicyRequest request)
AWSMailManager
Update attributes of an already provisioned traffic policy resource.
updateTrafficPolicy
in interface AWSMailManager
public void shutdown()
AWSMailManager
shutdown
in interface AWSMailManager
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSMailManager
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSMailManager
request
- The originally executed request.