fortios.filter/email.Mheader
Explore with Pulumi AI
Configure AntiSpam MIME header. Applies to FortiOS Version >= 6.2.4
.
Create Mheader Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Mheader(name: string, args?: MheaderArgs, opts?: CustomResourceOptions);
@overload
def Mheader(resource_name: str,
args: Optional[MheaderArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Mheader(resource_name: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
entries: Optional[Sequence[MheaderEntryArgs]] = None,
fosid: Optional[int] = None,
get_all_tables: Optional[str] = None,
name: Optional[str] = None,
vdomparam: Optional[str] = None)
func NewMheader(ctx *Context, name string, args *MheaderArgs, opts ...ResourceOption) (*Mheader, error)
public Mheader(string name, MheaderArgs? args = null, CustomResourceOptions? opts = null)
public Mheader(String name, MheaderArgs args)
public Mheader(String name, MheaderArgs args, CustomResourceOptions options)
type: fortios:filter/email/mheader:Mheader
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MheaderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args MheaderArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args MheaderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MheaderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MheaderArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Mheader 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 Mheader resource accepts the following input properties:
- Comment string
- Optional comments.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Entries
List<Pulumiverse.
Fortios. Filter. Email. Inputs. Mheader Entry> - Spam filter mime header content. The structure of
entries
block is documented below. - Fosid int
- ID.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Name string
- Name of table.
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Comment string
- Optional comments.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Entries
[]Mheader
Entry Args - Spam filter mime header content. The structure of
entries
block is documented below. - Fosid int
- ID.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Name string
- Name of table.
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment String
- Optional comments.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries
List<Mheader
Entry> - Spam filter mime header content. The structure of
entries
block is documented below. - fosid Integer
- ID.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name String
- Name of table.
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment string
- Optional comments.
- dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries
Mheader
Entry[] - Spam filter mime header content. The structure of
entries
block is documented below. - fosid number
- ID.
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name string
- Name of table.
- vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment str
- Optional comments.
- dynamic_
sort_ strsubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries
Sequence[Mheader
Entry Args] - Spam filter mime header content. The structure of
entries
block is documented below. - fosid int
- ID.
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name str
- Name of table.
- vdomparam str
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment String
- Optional comments.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries List<Property Map>
- Spam filter mime header content. The structure of
entries
block is documented below. - fosid Number
- ID.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name String
- Name of table.
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Outputs
All input properties are implicitly available as output properties. Additionally, the Mheader 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 Mheader Resource
Get an existing Mheader 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?: MheaderState, opts?: CustomResourceOptions): Mheader
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
entries: Optional[Sequence[MheaderEntryArgs]] = None,
fosid: Optional[int] = None,
get_all_tables: Optional[str] = None,
name: Optional[str] = None,
vdomparam: Optional[str] = None) -> Mheader
func GetMheader(ctx *Context, name string, id IDInput, state *MheaderState, opts ...ResourceOption) (*Mheader, error)
public static Mheader Get(string name, Input<string> id, MheaderState? state, CustomResourceOptions? opts = null)
public static Mheader get(String name, Output<String> id, MheaderState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Comment string
- Optional comments.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Entries
List<Pulumiverse.
Fortios. Filter. Email. Inputs. Mheader Entry> - Spam filter mime header content. The structure of
entries
block is documented below. - Fosid int
- ID.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Name string
- Name of table.
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Comment string
- Optional comments.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Entries
[]Mheader
Entry Args - Spam filter mime header content. The structure of
entries
block is documented below. - Fosid int
- ID.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Name string
- Name of table.
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment String
- Optional comments.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries
List<Mheader
Entry> - Spam filter mime header content. The structure of
entries
block is documented below. - fosid Integer
- ID.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name String
- Name of table.
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment string
- Optional comments.
- dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries
Mheader
Entry[] - Spam filter mime header content. The structure of
entries
block is documented below. - fosid number
- ID.
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name string
- Name of table.
- vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment str
- Optional comments.
- dynamic_
sort_ strsubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries
Sequence[Mheader
Entry Args] - Spam filter mime header content. The structure of
entries
block is documented below. - fosid int
- ID.
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name str
- Name of table.
- vdomparam str
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- comment String
- Optional comments.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- entries List<Property Map>
- Spam filter mime header content. The structure of
entries
block is documented below. - fosid Number
- ID.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- name String
- Name of table.
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Supporting Types
MheaderEntry, MheaderEntryArgs
- Action string
- Mark spam or good. Valid values:
spam
,clear
. - Fieldbody string
- Pattern for the header field body.
- Fieldname string
- Pattern for header field name.
- Id int
- Mime header entry ID.
- Pattern
Type string - Wildcard pattern or regular expression. Valid values:
wildcard
,regexp
. - Status string
- Enable/disable status. Valid values:
enable
,disable
.
- Action string
- Mark spam or good. Valid values:
spam
,clear
. - Fieldbody string
- Pattern for the header field body.
- Fieldname string
- Pattern for header field name.
- Id int
- Mime header entry ID.
- Pattern
Type string - Wildcard pattern or regular expression. Valid values:
wildcard
,regexp
. - Status string
- Enable/disable status. Valid values:
enable
,disable
.
- action String
- Mark spam or good. Valid values:
spam
,clear
. - fieldbody String
- Pattern for the header field body.
- fieldname String
- Pattern for header field name.
- id Integer
- Mime header entry ID.
- pattern
Type String - Wildcard pattern or regular expression. Valid values:
wildcard
,regexp
. - status String
- Enable/disable status. Valid values:
enable
,disable
.
- action string
- Mark spam or good. Valid values:
spam
,clear
. - fieldbody string
- Pattern for the header field body.
- fieldname string
- Pattern for header field name.
- id number
- Mime header entry ID.
- pattern
Type string - Wildcard pattern or regular expression. Valid values:
wildcard
,regexp
. - status string
- Enable/disable status. Valid values:
enable
,disable
.
- action str
- Mark spam or good. Valid values:
spam
,clear
. - fieldbody str
- Pattern for the header field body.
- fieldname str
- Pattern for header field name.
- id int
- Mime header entry ID.
- pattern_
type str - Wildcard pattern or regular expression. Valid values:
wildcard
,regexp
. - status str
- Enable/disable status. Valid values:
enable
,disable
.
- action String
- Mark spam or good. Valid values:
spam
,clear
. - fieldbody String
- Pattern for the header field body.
- fieldname String
- Pattern for header field name.
- id Number
- Mime header entry ID.
- pattern
Type String - Wildcard pattern or regular expression. Valid values:
wildcard
,regexp
. - status String
- Enable/disable status. Valid values:
enable
,disable
.
Import
Emailfilter Mheader can be imported using any of these accepted formats:
$ pulumi import fortios:filter/email/mheader:Mheader labelname {{fosid}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:filter/email/mheader:Mheader labelname {{fosid}}
$ unset “FORTIOS_IMPORT_TABLE”
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- fortios pulumiverse/pulumi-fortios
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
fortios
Terraform Provider.