1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectEmailfilterProfileImap
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.ObjectEmailfilterProfileImap

Explore with Pulumi AI

IMAP.

This resource is a sub resource for variable imap of resource fortimanager.ObjectEmailfilterProfile. Conflict and overwrite may occur if use both of them.

Create ObjectEmailfilterProfileImap Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ObjectEmailfilterProfileImap(name: string, args: ObjectEmailfilterProfileImapArgs, opts?: CustomResourceOptions);
@overload
def ObjectEmailfilterProfileImap(resource_name: str,
                                 args: ObjectEmailfilterProfileImapInitArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def ObjectEmailfilterProfileImap(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 profile: Optional[str] = None,
                                 action: Optional[str] = None,
                                 adom: Optional[str] = None,
                                 log: Optional[str] = None,
                                 log_all: Optional[str] = None,
                                 object_emailfilter_profile_imap_id: Optional[str] = None,
                                 scopetype: Optional[str] = None,
                                 tag_msg: Optional[str] = None,
                                 tag_types: Optional[Sequence[str]] = None)
func NewObjectEmailfilterProfileImap(ctx *Context, name string, args ObjectEmailfilterProfileImapArgs, opts ...ResourceOption) (*ObjectEmailfilterProfileImap, error)
public ObjectEmailfilterProfileImap(string name, ObjectEmailfilterProfileImapArgs args, CustomResourceOptions? opts = null)
public ObjectEmailfilterProfileImap(String name, ObjectEmailfilterProfileImapArgs args)
public ObjectEmailfilterProfileImap(String name, ObjectEmailfilterProfileImapArgs args, CustomResourceOptions options)
type: fortimanager:ObjectEmailfilterProfileImap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ObjectEmailfilterProfileImapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ObjectEmailfilterProfileImapInitArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ObjectEmailfilterProfileImapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ObjectEmailfilterProfileImapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectEmailfilterProfileImapArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var objectEmailfilterProfileImapResource = new Fortimanager.ObjectEmailfilterProfileImap("objectEmailfilterProfileImapResource", new()
{
    Profile = "string",
    Action = "string",
    Adom = "string",
    Log = "string",
    LogAll = "string",
    ObjectEmailfilterProfileImapId = "string",
    Scopetype = "string",
    TagMsg = "string",
    TagTypes = new[]
    {
        "string",
    },
});
Copy
example, err := fortimanager.NewObjectEmailfilterProfileImap(ctx, "objectEmailfilterProfileImapResource", &fortimanager.ObjectEmailfilterProfileImapArgs{
	Profile:                        pulumi.String("string"),
	Action:                         pulumi.String("string"),
	Adom:                           pulumi.String("string"),
	Log:                            pulumi.String("string"),
	LogAll:                         pulumi.String("string"),
	ObjectEmailfilterProfileImapId: pulumi.String("string"),
	Scopetype:                      pulumi.String("string"),
	TagMsg:                         pulumi.String("string"),
	TagTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var objectEmailfilterProfileImapResource = new ObjectEmailfilterProfileImap("objectEmailfilterProfileImapResource", ObjectEmailfilterProfileImapArgs.builder()
    .profile("string")
    .action("string")
    .adom("string")
    .log("string")
    .logAll("string")
    .objectEmailfilterProfileImapId("string")
    .scopetype("string")
    .tagMsg("string")
    .tagTypes("string")
    .build());
Copy
object_emailfilter_profile_imap_resource = fortimanager.ObjectEmailfilterProfileImap("objectEmailfilterProfileImapResource",
    profile="string",
    action="string",
    adom="string",
    log="string",
    log_all="string",
    object_emailfilter_profile_imap_id="string",
    scopetype="string",
    tag_msg="string",
    tag_types=["string"])
Copy
const objectEmailfilterProfileImapResource = new fortimanager.ObjectEmailfilterProfileImap("objectEmailfilterProfileImapResource", {
    profile: "string",
    action: "string",
    adom: "string",
    log: "string",
    logAll: "string",
    objectEmailfilterProfileImapId: "string",
    scopetype: "string",
    tagMsg: "string",
    tagTypes: ["string"],
});
Copy
type: fortimanager:ObjectEmailfilterProfileImap
properties:
    action: string
    adom: string
    log: string
    logAll: string
    objectEmailfilterProfileImapId: string
    profile: string
    scopetype: string
    tagMsg: string
    tagTypes:
        - string
Copy

ObjectEmailfilterProfileImap Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ObjectEmailfilterProfileImap resource accepts the following input properties:

Profile This property is required. string
Profile.
Action string
Action for spam email. Valid values: pass, tag.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Log string
Enable/disable logging. Valid values: disable, enable.
LogAll string
Enable/disable logging of all email traffic. Valid values: disable, enable.
ObjectEmailfilterProfileImapId string
an identifier for the resource.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TagMsg string
Subject text or header added to spam email.
TagTypes List<string>
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
Profile This property is required. string
Profile.
Action string
Action for spam email. Valid values: pass, tag.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Log string
Enable/disable logging. Valid values: disable, enable.
LogAll string
Enable/disable logging of all email traffic. Valid values: disable, enable.
ObjectEmailfilterProfileImapId string
an identifier for the resource.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TagMsg string
Subject text or header added to spam email.
TagTypes []string
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
profile This property is required. String
Profile.
action String
Action for spam email. Valid values: pass, tag.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log String
Enable/disable logging. Valid values: disable, enable.
logAll String
Enable/disable logging of all email traffic. Valid values: disable, enable.
objectEmailfilterProfileImapId String
an identifier for the resource.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tagMsg String
Subject text or header added to spam email.
tagTypes List<String>
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
profile This property is required. string
Profile.
action string
Action for spam email. Valid values: pass, tag.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log string
Enable/disable logging. Valid values: disable, enable.
logAll string
Enable/disable logging of all email traffic. Valid values: disable, enable.
objectEmailfilterProfileImapId string
an identifier for the resource.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tagMsg string
Subject text or header added to spam email.
tagTypes string[]
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
profile This property is required. str
Profile.
action str
Action for spam email. Valid values: pass, tag.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log str
Enable/disable logging. Valid values: disable, enable.
log_all str
Enable/disable logging of all email traffic. Valid values: disable, enable.
object_emailfilter_profile_imap_id str
an identifier for the resource.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tag_msg str
Subject text or header added to spam email.
tag_types Sequence[str]
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
profile This property is required. String
Profile.
action String
Action for spam email. Valid values: pass, tag.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log String
Enable/disable logging. Valid values: disable, enable.
logAll String
Enable/disable logging of all email traffic. Valid values: disable, enable.
objectEmailfilterProfileImapId String
an identifier for the resource.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tagMsg String
Subject text or header added to spam email.
tagTypes List<String>
Tag subject or header for spam email. Valid values: subject, header, spaminfo.

Outputs

All input properties are implicitly available as output properties. Additionally, the ObjectEmailfilterProfileImap resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ObjectEmailfilterProfileImap Resource

Get an existing ObjectEmailfilterProfileImap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ObjectEmailfilterProfileImapState, opts?: CustomResourceOptions): ObjectEmailfilterProfileImap
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        adom: Optional[str] = None,
        log: Optional[str] = None,
        log_all: Optional[str] = None,
        object_emailfilter_profile_imap_id: Optional[str] = None,
        profile: Optional[str] = None,
        scopetype: Optional[str] = None,
        tag_msg: Optional[str] = None,
        tag_types: Optional[Sequence[str]] = None) -> ObjectEmailfilterProfileImap
func GetObjectEmailfilterProfileImap(ctx *Context, name string, id IDInput, state *ObjectEmailfilterProfileImapState, opts ...ResourceOption) (*ObjectEmailfilterProfileImap, error)
public static ObjectEmailfilterProfileImap Get(string name, Input<string> id, ObjectEmailfilterProfileImapState? state, CustomResourceOptions? opts = null)
public static ObjectEmailfilterProfileImap get(String name, Output<String> id, ObjectEmailfilterProfileImapState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectEmailfilterProfileImap    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Action string
Action for spam email. Valid values: pass, tag.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Log string
Enable/disable logging. Valid values: disable, enable.
LogAll string
Enable/disable logging of all email traffic. Valid values: disable, enable.
ObjectEmailfilterProfileImapId string
an identifier for the resource.
Profile string
Profile.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TagMsg string
Subject text or header added to spam email.
TagTypes List<string>
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
Action string
Action for spam email. Valid values: pass, tag.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Log string
Enable/disable logging. Valid values: disable, enable.
LogAll string
Enable/disable logging of all email traffic. Valid values: disable, enable.
ObjectEmailfilterProfileImapId string
an identifier for the resource.
Profile string
Profile.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TagMsg string
Subject text or header added to spam email.
TagTypes []string
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
action String
Action for spam email. Valid values: pass, tag.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log String
Enable/disable logging. Valid values: disable, enable.
logAll String
Enable/disable logging of all email traffic. Valid values: disable, enable.
objectEmailfilterProfileImapId String
an identifier for the resource.
profile String
Profile.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tagMsg String
Subject text or header added to spam email.
tagTypes List<String>
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
action string
Action for spam email. Valid values: pass, tag.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log string
Enable/disable logging. Valid values: disable, enable.
logAll string
Enable/disable logging of all email traffic. Valid values: disable, enable.
objectEmailfilterProfileImapId string
an identifier for the resource.
profile string
Profile.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tagMsg string
Subject text or header added to spam email.
tagTypes string[]
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
action str
Action for spam email. Valid values: pass, tag.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log str
Enable/disable logging. Valid values: disable, enable.
log_all str
Enable/disable logging of all email traffic. Valid values: disable, enable.
object_emailfilter_profile_imap_id str
an identifier for the resource.
profile str
Profile.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tag_msg str
Subject text or header added to spam email.
tag_types Sequence[str]
Tag subject or header for spam email. Valid values: subject, header, spaminfo.
action String
Action for spam email. Valid values: pass, tag.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
log String
Enable/disable logging. Valid values: disable, enable.
logAll String
Enable/disable logging of all email traffic. Valid values: disable, enable.
objectEmailfilterProfileImapId String
an identifier for the resource.
profile String
Profile.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
tagMsg String
Subject text or header added to spam email.
tagTypes List<String>
Tag subject or header for spam email. Valid values: subject, header, spaminfo.

Import

ObjectEmailfilter ProfileImap can be imported using any of these accepted formats:

Set import_options = [“profile=YOUR_VALUE”] in the provider section.

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectEmailfilterProfileImap:ObjectEmailfilterProfileImap labelname ObjectEmailfilterProfileImap
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.