Votiro Cloud for Email Operation Overview
Edge Transport Server and Transport Service
Microsoft Exchange Edge Transport servers handle all inbound and outbound Internet mail flow, by providing mail relay and smart host services for an organization. Transport agents running on the Edge Transport server provide additional layers of message protection and security.
The transport service, also referred to as a transport pipeline, is a collection of services, connections, components, queues and server roles that work together to route email messages to and from an organization in the MS Exchange server.
The transport service handles SMTP mail flow, performs message categorization and drives the VotiroVotiro Cloud for Email transport agent.
Integration as a Transport Agent
Votiro Cloud for Email is a transport agent created by Votiro to communicate with VotiroVotiro Cloud to provide positive selection processing for emails.
Transport agents have full access to emails they encounter on the network. Votiro Cloud for Email utilizes the SmtpReceiveAgent for processing all SMTP Receive events from the MS Exchange server that are initiated by remote SMTP servers, such as a mail transfer agent or an email server on the Internet.
Only inbound emails are processed on a typical (and recommended) deployment. Outbound and internal emails within the organization are not processed.
Integration with the Positive Selection® Engine
Before you integrate Votiro Cloud for Email with the Microsoft Exchange Edge Transport Server, you must verify that the Attachment Filtering function is disabled. Run the Disable-TransportAgent Attachment Filtering Agent Exchange PowerShell command to disable the function.
When an SMTP session is initiated with the Microsoft Exchange Edge Transport Server services, it generates an email that is processed and then routed to Votiro Cloud for Email transfer agent. Votiro Cloud for Email implements the Votiro API and queues the files for positive selection by the Positive Selection® Engine.
When a file is successfully uploaded to the Positive Selection® Engine for processing, Votiro Cloud for Email polls the engine for the status. Polling continues throughout the positive selection process, until the file is downloaded. These requests enable internal coordination, tracking and bi-directional communication for each file transferred to the Positive Selection® Engine for processing. Each status request tracks the time and processing of the email through the positive selection process. The possible responses to the status requests are described in the following table.
Response |
Description |
---|---|
Queued |
The email is queued to be sent to the Positive Selection® Engine. Emails remain in queued status until a positive selection worker-thread is available. |
Processing |
The email is being processed for positive selection. |
Done |
The positive selection process is complete. |
Blocked |
The email is blocked from processing. |
Error |
An internal error was encountered by the Positive Selection® Engine while processing the file. |
LimitExceeded |
Exceeded the number of uploads. |
Although the email is transferred to the Positive Selection® Engine during the SMTP session, the SMTP session is not considered complete until the Positive Selection® Engine processes the file, which means that the initiating server does not receive delivery approval for the file until positive selection processing is finished. To ensure that the positive selection process does not cause timeouts to be triggered, you might need to adjust the respective timeout values for any of the preceding components. For example, the timeout values of the initiating servers, such as anti-spam or mail relay might need to be adjusted.
If the Positive Selection® Engine cannot process the file, *** Unsanitized *** is added to the beginning of the subject line of the email. To ensure business continuity, the email is routed to the next SMTP server in the process of delivering the email to the recipient.
You can configure the text that will be added to the subject line of an unsanitized email. In the WebApiHandlerConfig.xml configuration file, edit the following line, as needed.
SubjectPrefixOnError="***Unsanitized***"
The SMTPActionOnError configuration parameter in the WebApiHandlerConfig.xml file provides two options for handling emails that have failed to undergo positive selection:
n | Reject: will invoke a system-generated notification email to the sender. It will not contain the prefix *** Unsanitized *** (or other text that you have configured) in the subject line. |
n | Pass will not generate a notification email to the sender. This is the default value. |
Example
<SmtpSettings SmtpActionOnError="Pass">
Note
The characters &, <, >, ‘, and “ are not permitted within the attribute value in an XML file.
Email Connector-Specific Internet X-Headers
Each email that is processed by Votiro Cloud for Email includes Email Connector-specific internet X-headers. The X-headers provide key information that relates to the positive selection processing, tracking and troubleshooting of each email.
X-Headers are not usually visible to the recipients unless they specifically request the header information from the email client application.
X-Header |
Description |
---|---|
X-MTRecipients |
Lists the SMTP (envelope) recipients who are in the Microsoft Exchange server authoritative domain. This header is used to release emails to intended recipients in the organization. |
X-MTConnectorResult |
Indicates if the email has been processed. The result is Sanitized, Timeout, WebApiInternalError or Blocked. |
X-Votiro-Connector-WebApi-MsgId |
An internal Email Connector identifier. |
X-Votiro-Connector-WebApi-ItemId |
An internal identifier to the file that enables status tracking. |
X-Votiro-Connector-WebApi-TotalTime |
Represents the total time to upload, queue, process and download the email. The result is in HH:MM:SS:MS format. |
X-Votiro-Connector-WebApi-UploadTime |
Represents the time to upload the email to the Positive Selection® Engine. The result is in HH:MM:SS:MS format. |
X-Votiro-Connector-WebApi-QueuedTime |
Represents the time the email is queued for processing. The result is in HH:MM:SS:MS format. |
X-Votiro-Connector-WebApi-ProcessTime |
Represents the processing time. The result is in HH:MM:SS:MS format. |
X-Votiro-Connector-WebApi-DownloadTime |
Represents the time to download the email. The result is in HH:MM:SS:MS format. |
The X-Header X-MTConnectorResult returns the final status of the positive selection process for the email. Below are the descriptions for the results.
X-MT Connector Result |
Description |
---|---|
Sanitized |
The Positive Selection® Engine sent a Done response. The file is processed. |
Blocked |
The Positive Selection® Engine sent a Blocked response. The file is blocked. |
WebApiInternalError |
The Positive Selection® Engine sent an Error response. The file is not processed. |
TimeOut |
The Email Connector timed out while waiting for a response from the Positive Selection® Engine. |
Sample X-Headers
X-MTRecipients: user@company.com
X-MTConnectorResult: Sanitized
X-Votiro-Connector-WebApi-MsgId: ee4871d2-e140-4a05-9306-c3ab309dd18f
X-Votiro-Connector-WebApi-ItemId: 560eab29-fbcb-436b-99f1-13b85efee39a
X-Votiro-Connector-WebApi-TotalTime: 00:00:02.4156542
X-Votiro-Connector-WebApi-UploadTime: 00:00:00.0376172
X-Votiro-Connector-WebApi-QueuedTime: 00:00:01.8574844
X-Votiro-Connector-WebApi-ProcessTime: 00:00:00.5167820
X-Votiro-Connector-WebApi-DownloadTime: 00:00:00.0037706
Comments
0 comments
Please sign in to leave a comment.