Variable
|
Description
|
AltParser
|
If this value is set to 'True', GetMail to examine the attachments of messages it receives IF the body of the message is completely blank.
If the attachment is in an ASCII format (HTML, XML, etc), the program will use the contents of the file as the body of the message.
Things the regular parser doesn't / can't do that the AltParser can:
1. If there is no plain text version of the message body, it will use the HTML version of the message body
2. If there is no message body at all, it will use the first attached message and try to get the body out of that
3. If there is no body at all, and no attached messages, it will use the first attachment as the message body
Possible Values: True or False
Example: AltParser = True
|
AltParserStripTags
|
This value will only work if AltParser = True is also present in the template.
If this value is set to 'True', GetMail will remove formatting tags from the data parsed from attached files.
Possible Value: True or False
Example: AltParserStripTags = True
|
UseAttachmentAsBody
|
This value will only work if AltParser = True is also present in the template.
This parameter has two possible value types.
1)If you set the value a number (less than 100), it designates which attachment to use by numerical order. If there are three attachments on the email and you use the number 2, the second attachment will be selected and its' contents will be used as the message body. Example: UseAttachmentAsBody = 2
2)If you set it to a filename, it will use the contents of that named attachment file as the message body. Example: UseAttachmentAsBody = ASpecificFileName.txt
Both of the above assume that the attachment is plain text.
|
ForceAdhocEmail
|
Enabling this parameter tells GetMail that mailbox value for every incoming message should be treated as ad-hoc. When this is enabled, PageGate will not try to match the incoming mailbox name with a recipient or group.
Possible Values: True or False
Example: ForceAdhocEmail = True
|
InterfaceFilter
|
You must own the PageGate Filter pack and the filter's support files must reside in the PageGate program directory to use this parameter.
This parameter calls on the filter after messages have been extracted from the incoming email and decoding has taken place.
Possible Values: The full path and file name of the filter you want to run.
Example: InterfaceFilter = c:\PageGateData\Filters\yourfilter.xml
|
InterfaceFilterDebugFile
|
When using an interface filter, you can use this parameter to output this specific filter's log to the declared location and file name.
Possible Values: The full path and file name of the debug log you want to output.
Example: InterfaceFilterDebugFile = c:\PageGateData\Filters\GetMailFilter.log
|
RawInterfaceFilter
|
You must own the PageGate Filter pack and the filter's support files must reside in the PageGate program directory to use this parameter.
This parameter calls on the filter before messages have been extracted from the incoming email and decoding has taken place/
Possible Values: The full path and file name of the filter you want to run.
Example: RawInterfaceFilter = c:\PageGateData\Filters\yourfilter.xml
|
RawInterfaceFilterDebugFile
|
When using a raw interface filter, you can use this parameter to output this specific filter's log to the declared location and file name.
Possible Values: The full path and file name of the debug log you want to output.
Example: RawInterfaceFilterDebugFile = c:\PageGateData\Filters\ProcessingFilter.log
|
SubjectFilter
|
You must own the PageGate Filter pack and the filter's support files must reside in the PageGate program directory to use this parameter.
This parameter calls on a filter that will only work with the contents of the subject line and will not influence the recipient(s) or body of the message.
Possible Values: The full path and file name of the filter you want to run.
Example: SubjectFilter = c:\PageGateData\Filters\YourSubjectFilter.xml
|
SubjectFilterDebugFile
|
When using a subject filter, you can use this parameter to output this specific filter's log to the declared location and file name.
Possible Values: The full path and file name of the debug log you want to output.
Example: SubjectFilterDebugFile = c:\PageGateData\Filters\SubjectProcessingFilter.log
|
UseFilterDll
|
You must own the PageGate Filter pack and the filter's support files must reside in the PageGate program directory to use this parameter.
Setting this parameter to true tells PageGate to use the filter dll, which is a more efficient method of running the filter.
Possible Values: True or False
Example: UseFilterDll = True
|
MsDeliveryPort
|
This value controls the port that PageGate's mail server will use to deliver traffic. Thee default port is 25. Port 465 will automatically use TLS, 587 will automatically use STARTTLS.
Possible Values: 25, 465, 587 or any custom port
Example: MsDeliveryPort = 587
|
MsDeliveryAuthMethod
|
By default, PageGate uses ANY, meaning that the delivery engine will respond to the security callouts provided by mail server being connected to. This parameter overrides that tells PageGate's mail server to exclusively use the specified authentication method.
Possible Values: NONE, ANY, PLAIN, LOGIN, CRAM-MD5, OAUTH
Example: MsDeliveryAuthMethod = OAUTH
|
MsDeliveryAuthUsername
|
When using authentication, this value provides the username to be used.
Possible Values: A username. This will often be a fully qualified email address but doesn't necessarily have to be.
Example: MsDeliveryAuthUsername = dispatch@your.email.domain
|
MsDeliveryAuthPassword
|
When using authentication, this value provides the password to be used.
Possible Values: A password.
Example: MsDeliveryAuthPassword = 8N'3Yb17^s]A
|
MsDeliveryAuthClientId
|
When using OAUTH style authentication, this is the ClientId that will be provided.
Possible Values: The ClientId created in the Microsoft Entra portal. Please see the Configuring OAUTH section of the documentation for more information.
Example: Please see the Configuring OAUTH section of the documentation for more information.
|
MsDeliveryAuthClientSecret
|
When using OAUTH style authentication, this is the ClientISecret value that will be provided.
Possible Values: The Client Secret created in the Microsoft Entra portal. Please see the Configuring OAUTH section of the documentation for more information.
Example: Please see the Configuring OAUTH section of the documentation for more information.
|
MsDeliveryAuthTokenEndpoint
|
When using OAUTH style authentication, this is the AuthToken Endpoint value that will be provided.
Possible Values: The AuthToken Endpoint retrieved from the PageGate OAUTH application. Please see the Configuring OAUTH section of the documentation for more information.
Example: Please see the Configuring OAUTH section of the documentation for more information.
|
MsDeliveryAuthToken
|
When using OAUTH style authentication, this is the AuthToken that will be provided.
Possible Values: The AuthToken retrieved from the PageGate OAUTH application. Please see the Configuring OAUTH section of the documentation for more information.
Example: Please see the Configuring OAUTH section of the documentation for more information.
|
MsDeliveryAuthRefreshToken
|
When using OAUTH style authentication, this is the AuthToken Endpoint value that will be provided.
Possible Values: The AuthToken Endpoint retrieved from the PageGate OAUTH application. Please see the Configuring OAUTH section of the documentation for more information.
Example: Please see the Configuring OAUTH section of the documentation for more information.
|