/n software Adapters for BizTalk

Questions / Feedback?

SMIMEEmail Adapter

Properties   Configuration Settings  

The SMIMEEmail Adapter adds S/MIME-protected email capability to the BizTalk Server.

Remarks

The SMIMEEmail Adapter adds support for sending and receiving S/MIME-protected emails to BizTalk Server. The adapter allows you to encrypt and sign emails before sending and decrypt and verify signatures on received emails.

SMIMEEmail Receiver Adapter

The SMIMEEmail Receiver adapter is the S/MIME enabled equivalent of the Email Receive adapter. In addition to standard IMAP and POP3 functions, the SMIMEEmail Receiver adapter can decrypt and/or verify message signatures. In order to use the SMIMEEmail Receiver adapter, you must first select a ServerType. You must also enter a MailServer and User. For servers that require authentication, you will also have to enter a Password. To activate SSL, you must also set the SSLAcceptServerCert and SSLStartMode. The adapter will attempt to determine the correct port to connect to based on the server type and SSL settings. However, you may override the default by directly setting the MailPort in the property pages.

Once you have your port set up, the adapter will connect to the server once every PollingInterval and download messages. To control how the messages are downloaded, or to prevent duplicate messages from being fetched from the mail server, you may set the DeleteMode to an appropriate value. For IMAP connections, you may also set a Filter.

The adapter will write as much information as it has regarding the emails to various properties in the message context that can be polled at runtime. These include MessageFrom, MessageTo, MessageSubject and MessageHeaders. The message headers may also be included with the message body by setting the IncludeHeaders property to True.

When it receives an email, the SMIMEEmail Reciever adapter will detect if the message is encrypted and attempt to decrypt it using the certificate in the Certificate property. If the message is signed, it will also attempt to verify the signature using the certificate in the SignerCert property.

SMIMEEmail Sender Adapter

The SMIMEEmail Sender Adapter is a complete SMTP client that can also encrypt and sign emails. To send emails from the adapter you must set at a minimum your SMTPServer, as well as your From and SendTo email addresses. Should you need to guarantee a secure transmission, you may set the SSLCert and SSLStartMode properties, as well as a specific SSLAcceptServerCert.

You may also add carbon copy and blind carbon copy recipients via the Cc and BCc properties. If you wish to receive delivery or read notifications, you can set the DeliveryReceipt and ReadReceipt properties. You may set the Subject of your message. The contents of the outbound message will be sent as the body of the email.

If you want to encrypt an email you are sending, set the RecipientCert property to the receiver's certificate, set the EncryptData property to true, and set EncryptingAlgorithm to the encryption algorithm you want to use. To sign an email, set the Certificate property to your certificate, set the SignData property to true, and set the SigningAlgorithm property to the hash algorithm you want to use for signing.

Receiver Property List


The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.

AttachmentDirectorySpecifies the directory to which attachments are saved.
AuthModeThe authentication mode to be used when connecting to the MailServer .
CertificateThe Certificate used to sign (Encoder) and decrypt (Decoder) messages.
DeleteModeControls if and when the email is deleted after download.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FilterA filter to be applied to the inbox when selecting messages.
FirewallA set of properties related to firewall access.
IncludeHeadersInstructs the adapter to include or ignore message headers.
MailFolderName of the mailbox selected on the server.
MailPortThe port of the mail server (IMAP or POP3).
MailServerThe name or address of the mail server (IMAP or POP3).
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
MessageCcA comma separated list of addresses for carbon copies.
MessageDateThe date a message was sent.
MessageFromThe email address of the author of the message.
MessageHeadersMessage headers associated with the current email message.
MessageIdThe id of the current message.
MessageNetIdThe globally unique identifier of the message.
MessageSenderThe email address of the sender.
MessageSizeThe size of the current message.
MessageSubjectThe subject of the mail message.
MessageToA comma separated list of addresses for destinations.
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordA password for login.
PersistentConnectionInstructs the adapter whether to keep the connection to the server open.
PollingIntervalThe amount of time, in seconds, between download attempts.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RequireEncryptionWhether an error should be thrown if a received message is not encrypted.
RequireOAEPWhether an error should be thrown if OAEP was not used to encrypt the incoming message.
RequirePSSWhether an error should be thrown if RSA-PSS was not used to encrypt the incoming message.
RequireSignatureWhether an error should be thrown if a received message is not signed.
RuntimeLicenseSpecifies the adapter runtime license key.
ServerTypeThe type of server for your email account.
SignerCertContains the certificate of the message signer.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
TempPathThe path to which temporary files are written at runtime.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA user id for login.

Sender Property List


The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.

AttachmentsSpecifies which files the adapter should include as attachments in the outgoing message.
AuthModeThe authentication mode to be used when connecting to the MailServer .
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
CertificateThe Certificate used to sign (Encoder) and decrypt (Decoder) messages.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
DeliveryReceiptWhether or not a delivery receipt should be returned to the sender.
EncryptDataWhether to encrypt the MIME data.
EncryptingAlgorithmThe algorithm to use for encryption.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
IncludeCertificateSpecifies whether to include the signer's certificate with the signed message.
IncludeChainSpecifies whether to include the signer's certificate chain with the signed message.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageHeadersMessage headers associated with the current email message.
MessageHTMLThe HTML text of the message.
MessageTextThe text of the mail message (optional).
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordA password for login.
ReadReceiptWhether or not a receipt should be sent when the email has been read.
RecipientCertThe certificate used to encrypt the MIME data.
ReplyToA mail address to reply to (optional).
RuntimeLicenseSpecifies the adapter runtime license key.
SendToA comma separated list of addresses for destinations (required).
SignDataWhether to sign the MIME data.
SigningAlgorithmTextual description of the signature hash algorithm.
SMTPMessageIdThe id of the mail message (optional).
SMTPPortThe server port for SMTP (default 25).
SMTPServerThe name or address of a mail server (mail relay).
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
SubjectThe subject of the mail message (optional).
TempPathThe path to which temporary files are written at runtime.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UseOAEPWhether to use OAEP when encrypting the MIME data.
UsePSSWhether to use RSA-PSS when signing.
UserA user id for login.

Configuration Settings


The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.

AutoNormalizeLFWhether to automatically determine how to normalize the MIC when verifying a signature.
SMIMECapabilitiesSpecifies the algorithms to include in the sMIMECapabilities object in the signature.
AddAttachmentsAsMessagePartsIncludes attachments as additional parts on the message.
AttachmentEncoding[index]Content-Transfer-Encoding for attached file (at index).
AttachmentName[index]Filename for the attached file (at index).
AttachmentNameSourceSpecifies the source location in the MIME entity from which the filename is retrieved.
AttachmentType[index]Content-type for attached file (at index).
AutoDecodeHeadersWhether to decode headers.
AutoDecodeMessageTextWhether to decode non-MIME message text.
DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
DuplicateAttachmentActionSpecifies what action to take when a duplicate filename is encountered.
FoldHeadersWhether incoming message headers should be folded.
IncludeAttachmentsDetermines if additional message parts are added to the outgoing E-Mail as attachments.
IncludeFilterInURIDetermines if the Filter is appended to the URI.
MaskSensitiveWhether sensitive properties should be masked when logging.
MessageHTMLFileSpecifies a file that will be included as the email's HTML content.
MessageTextEncodingWhen set, the Text values will be encoded using the specified encoding.
MoveToSpecifies the IMAP folder on the server to which messages will be moved.
ReturnOnlyPlainTextPartSpecifies if the adapter should return the first plain text part or the entire message.
ReturnPathSets the Return-Path to be used for sending email.
UIDModeIf True, permanent message identifiers will be used instead of temporary identifiers.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 20.0 [Build 7724]