# API Reference
## Constructs
### Rootmail
Rootmail construct.
#### Initializers
```typescript
import { Rootmail } from '@mavogel/awscdk-rootmail'
new Rootmail(scope: Construct, id: string, props: RootmailProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | RootmailProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* RootmailProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { Rootmail } from '@mavogel/awscdk-rootmail'
Rootmail.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| emailBucket | aws-cdk-lib.aws_s3.Bucket | S3 bucket to store the root mails in. |
| hostedZoneParameterName | string | The name parameter in SSM to store the domain name server. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `emailBucket`Required
```typescript
public readonly emailBucket: Bucket;
```
- *Type:* aws-cdk-lib.aws_s3.Bucket
S3 bucket to store the root mails in.
---
##### `hostedZoneParameterName`Required
```typescript
public readonly hostedZoneParameterName: string;
```
- *Type:* string
The name parameter in SSM to store the domain name server.
---
### SESReceive
SES Receive construct.
#### Initializers
```typescript
import { SESReceive } from '@mavogel/awscdk-rootmail'
new SESReceive(scope: Construct, id: string, props: SESReceiveProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | SESReceiveProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* SESReceiveProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { SESReceive } from '@mavogel/awscdk-rootmail'
SESReceive.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
## Structs
### RootmailProps
Properties for the construct.
#### Initializer
```typescript
import { RootmailProps } from '@mavogel/awscdk-rootmail'
const rootmailProps: RootmailProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| domain | string | Domain used for root mail feature. |
| customSesReceiveFunction | aws-cdk-lib.aws_lambda.Function | The custom SES receive function to use. |
| emailBucketDeletePolicy | aws-cdk-lib.RemovalPolicy | The removal policy for the email bucket. |
| filteredEmailSubjects | string[] | Filtered email subjects. |
| setDestroyPolicyToAllResources | boolean | Whether to set all removal policies to DESTROY. |
| subdomain | string | Subdomain used for root mail feature. |
| totalTimeToWireDNS | aws-cdk-lib.Duration | The total time to wait for the DNS records to be available/wired. |
| wireDNSToHostedZoneID | string | The hosted zone ID of the domain that is registered Route53 AND in the same AWS account to enable autowiring of the DNS records. |
---
##### `domain`Required
```typescript
public readonly domain: string;
```
- *Type:* string
Domain used for root mail feature.
---
##### `customSesReceiveFunction`Optional
```typescript
public readonly customSesReceiveFunction: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
- *Default:* the provided functions within the construct
The custom SES receive function to use.
[disable-awslint:ref-via-interface]
---
##### `emailBucketDeletePolicy`Optional
```typescript
public readonly emailBucketDeletePolicy: RemovalPolicy;
```
- *Type:* aws-cdk-lib.RemovalPolicy
- *Default:* RemovalPolicy.RETAIN
The removal policy for the email bucket.
---
##### `filteredEmailSubjects`Optional
```typescript
public readonly filteredEmailSubjects: string[];
```
- *Type:* string[]
- *Default:* []
Filtered email subjects.
NOTE: must not contain commas.
---
##### `setDestroyPolicyToAllResources`Optional
```typescript
public readonly setDestroyPolicyToAllResources: boolean;
```
- *Type:* boolean
- *Default:* false
Whether to set all removal policies to DESTROY.
This is useful for integration testing purposes.
---
##### `subdomain`Optional
```typescript
public readonly subdomain: string;
```
- *Type:* string
- *Default:* 'aws'
Subdomain used for root mail feature.
---
##### `totalTimeToWireDNS`Optional
```typescript
public readonly totalTimeToWireDNS: Duration;
```
- *Type:* aws-cdk-lib.Duration
- *Default:* Duration.hours(2)
The total time to wait for the DNS records to be available/wired.
---
##### `wireDNSToHostedZoneID`Optional
```typescript
public readonly wireDNSToHostedZoneID: string;
```
- *Type:* string
- *Default:* emtpy string
The hosted zone ID of the domain that is registered Route53 AND in the same AWS account to enable autowiring of the DNS records.
---
### SESReceiveProps
Properties for the SESReceive construct.
#### Initializer
```typescript
import { SESReceiveProps } from '@mavogel/awscdk-rootmail'
const sESReceiveProps: SESReceiveProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| domain | string | Domain used for root mail feature. |
| emailbucket | aws-cdk-lib.aws_s3.IBucket | S3 bucket to store received emails. |
| subdomain | string | Subdomain used for root mail feature. |
| customSesReceiveFunction | aws-cdk-lib.aws_lambda.Function | The custom SES receive function to use. |
| filteredEmailSubjects | string[] | Filtered email subjects. |
| setDestroyPolicyToAllResources | boolean | Whether to set all removal policies to DESTROY. |
---
##### `domain`Required
```typescript
public readonly domain: string;
```
- *Type:* string
Domain used for root mail feature.
---
##### `emailbucket`Required
```typescript
public readonly emailbucket: IBucket;
```
- *Type:* aws-cdk-lib.aws_s3.IBucket
S3 bucket to store received emails.
[disable-awslint:prefer-ref-interface]
---
##### `subdomain`Required
```typescript
public readonly subdomain: string;
```
- *Type:* string
Subdomain used for root mail feature.
---
##### `customSesReceiveFunction`Optional
```typescript
public readonly customSesReceiveFunction: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
- *Default:* the provided functions within the construct
The custom SES receive function to use.
[disable-awslint:ref-via-interface]
---
##### `filteredEmailSubjects`Optional
```typescript
public readonly filteredEmailSubjects: string[];
```
- *Type:* string[]
- *Default:* 2 subjects: 'Your AWS Account is Ready - Get Started Now' and 'Welcome to Amazon Web Services'
Filtered email subjects.
NOTE: must not contain commas.
---
##### `setDestroyPolicyToAllResources`Optional
```typescript
public readonly setDestroyPolicyToAllResources: boolean;
```
- *Type:* boolean
- *Default:* false
Whether to set all removal policies to DESTROY.
This is useful for integration testing purposes.
---