AS1Receiver Module
Properties Methods Events Config Settings Errors
The AS1Receiver module is used to process AS1 messages and generate receipts.
Syntax
IPWorksEDI.As1receiver
Remarks
The AS1Receiver class allows you to receive AS1 messages as specified in RFC 3335. The class can act as an email client, decrypt and verify incoming messages, generate receipts including Message Disposition Notifications (MDNs), and send them over SMTP/S.
Basic Operation
You should first log in to your mail server by setting MailServer, User, and Password, and invoking Connect. You may then navigate your mail inbox by setting MailMessageNumber, and inspecting properties such as MailMessageFrom, etc. When you find the desired file you may download it by invoking ReadRequest. Alternatively, you may acquire the AS1 data by other means and directly set Request and RequestHeaders.
ReadRequest (or ParseHeaders) will determine information such as From and SendTo, which will allow you to set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.
Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in RFC 3335. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.
The MDNReceipt may be returned over SMTP/S by invoking SendResponse. In case the server address for incoming mail is different than that for outgoing mail you should use Config to configure this.
To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data, and will also write the received EDI files to disk.
Example
AS1Receiver1.User = "myusername"
AS1Receiver1.Password = "mypassword"
AS1Receiver1.MailServer = "1.2.3.4"
AS1Receiver1.Connect()
// You may need to search the server for received files at this point
AS1Receiver1.MessageNumber = 1;
// You may check properties such as MailMessageFrom, etc.
AS1Receiver1.ReadRequest()
AS1Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me");
AS1Receiver1.SignerCert = (base 64 encoded certificate);
AS1Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory";
AS1Receiver1.ProcessRequest();
AS1Receiver1.SendResponse();
AS1Receiver1.Disconnect();
Additional functionality allows the user to examine details of the client's
request, to permit certain types of errors, or to customize the outgoing MDN.
See the property and method list for details.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
Attachments | Collection of files attached to the current message. |
CertEncoded | This is the certificate (PEM/base64 encoded). |
CertStore | This is the name of the certificate store for the client certificate. |
CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
CertStoreType | This is the type of certificate store for this certificate. |
CertSubject | This is the subject of the certificate used for client authentication. |
CompressionFormat | The compression format used on the incoming message. |
Connected | This shows whether the module is connected. |
EDIData | The EDI data sent in Request . |
Firewall | A set of properties related to firewall access. |
From | The sender of the original message. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LogDirectory | The path to a directory for logging. |
LogFile | The log file written. |
MailMessageCc | The value of the Cc header of the mail message. |
MailMessageCount | The number of messages waiting in the mailbox. |
MailMessageDate | The message date for the currently selected message. |
MailMessageFrom | The sender of the mail message. |
MailMessageHeaders | The message headers for the currently selected message. |
MailMessageNumber | The message number on the incoming mail server. |
MailMessageReplyTo | The value of the ReplyTo header of the mail message. |
MailMessageSize | The size of the mail message. |
MailMessageSubject | The subject of the mail message. |
MailMessageText | The text of the mail message. |
MailMessageTo | The recipient of the mail message. |
MailMessageUID | The unique id of the mail message. |
MailServer | The address of your mail server. |
MDNReceipt | The MDN-based receipt generated by the module. |
MDNTo | The recipient for the Message Disposition Notification (MDN). |
MessageId | The message ID of the incoming message. |
Password | The password for your incoming mail server. |
Request | The AS1 request to be processed. |
RequestHeaders | The headers in the AS1 request. |
RequestHeadersString | The headers in the AS1 request. |
ScanResult | The result of invoking ParseRequest . |
SendTo | The recipient of the original message. |
SignerCertEncoded | This is the certificate (PEM/base64 encoded). |
SignerCertStore | This is the name of the certificate store for the client certificate. |
SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SignerCertStoreType | This is the type of certificate store for this certificate. |
SignerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLStartMode | Determines how the module starts the SSL negotiation. By default, SSL will not be used. |
User | The username for your incoming mail server. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Connect | Connects to the incoming mail server. |
CreateMDNReceipt | Creates MDNReceipt . |
DeleteMessage | Deletes the message specified by MailMessageNumber . |
Disconnect | Disconnects from the incoming mail server. |
ParseRequest | Parses the EDI message and determines the EDIData . |
ProcessQueue | Send the messages queued for sending. |
ProcessRequest | Processes the EDI data, and generates the receipt. |
Queue | Prepares and queues the message to the specified directory. |
ReadRequest | Reads the AS1 request from the mail server. |
Reset | Resets the state of the control. |
SelectMailMessage | Selects and obtains information about the specified message. |
SendResponse | Sends the MDN receipt. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
ConnectionStatus | This event is fired to indicate changes in the connection state. |
EndTransfer | Fired when the message text completes transferring. |
Error | Information about errors during data delivery. |
Header | This event is fired for every message header being retrieved. |
Log | Fired with log information while processing a message. |
PITrail | Traces the commands sent to the mail server, and the respective replies. |
SignerCertInfo | This event is fired during verification of the signed message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when the message text starts transferring (on either a send or receive). |
Transfer | Fired while the message text gets transferred to or from MailServer . |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
filename | The filename of the EDI Data. |
LogFilename | The base name of the log file. |
POPPort | The POP mail port to be used, if different than MailServer. |
POPServer | The POP server to be used, if different than MailServer. |
SMTPAuthMechanism | The authentication mechanism used to connect to the SMTP server. |
SMTPPassword | The password used for authentication. |
SMTPPort | The SMTP mail port to be used, if different than MailServer. |
SMTPServer | The SMTP server to be used, if different than MailServer. |
SMTPSSLStartMode | Determines how SSL negotiation starts with the SMTP server. |
SMTPUser | The user name used for authentication. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the module whether or not to use the system security libraries or an internal implementation. |
Attachments Property (AS1Receiver Module)
Collection of files attached to the current message.
Syntax
public var attachments: Array<EDIAttachment> { get {...} }
@property (nonatomic,readonly,assign,getter=attachmentCount) int attachmentCount; - (int)attachmentCount; - (NSString*)attachmentContentType:(int)attachmentIndex; - (NSString*)attachmentData:(int)attachmentIndex; - (NSData*)attachmentDataB:(int)attachmentIndex; - (NSString*)attachmentFilename:(int)attachmentIndex; - (NSString*)attachmentHeaders:(int)attachmentIndex; - (NSString*)attachmentName:(int)attachmentIndex;
Default Value
""
Remarks
The username for your incoming mail server. Set this before invoking Connect.
CertEncoded Property (AS1Receiver Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var certEncoded: String { get {...} set {...} }
public var certEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certEncoded,setter=setCertEncoded:) NSString* certEncoded; - (NSString*)certEncoded; - (void)setCertEncoded :(NSString*)newCertEncoded; @property (nonatomic,readwrite,assign,getter=certEncodedB,setter=setCertEncodedB:) NSData* certEncodedB; - (NSData*)certEncodedB; - (void)setCertEncodedB :(NSData*)newCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setCertEncodedB(certEncoded: Data) throws public func setCertEncoded(certEncoded: String) throws
CertStore Property (AS1Receiver Module)
This is the name of the certificate store for the client certificate.
Syntax
public var certStore: String { get {...} set {...} }
public var certStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certStore,setter=setCertStore:) NSString* certStore; - (NSString*)certStore; - (void)setCertStore :(NSString*)newCertStore; @property (nonatomic,readwrite,assign,getter=certStoreB,setter=setCertStoreB:) NSData* certStoreB; - (NSData*)certStoreB; - (void)setCertStoreB :(NSData*)newCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
CertStorePassword Property (AS1Receiver Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var certStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword; - (NSString*)certStorePassword; - (void)setCertStorePassword :(NSString*)newCertStorePassword;
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
CertStoreType Property (AS1Receiver Module)
This is the type of certificate store for this certificate.
Syntax
public var certStoreType: As1receiverCertStoreTypes { get {...} set {...} }
public enum As1receiverCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=certStoreType,setter=setCertStoreType:) int certStoreType; - (int)certStoreType; - (void)setCertStoreType :(int)newCertStoreType;
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
20 (cstSecurityKey) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
CertSubject Property (AS1Receiver Module)
This is the subject of the certificate used for client authentication.
Syntax
public var certSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=certSubject,setter=setCertSubject:) NSString* certSubject; - (NSString*)certSubject; - (void)setCertSubject :(NSString*)newCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setCertSubject(certSubject: String) throws
CompressionFormat Property (AS1Receiver Module)
The compression format used on the incoming message.
Syntax
public var compressionFormat: As1receiverCompressionFormats { get {...} }
public enum As1receiverCompressionFormats: Int32 { case cfNone = 0 case cfZLIB = 1 }
@property (nonatomic,readonly,assign,getter=compressionFormat) int compressionFormat; - (int)compressionFormat;
Default Value
0
Remarks
The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the class.
This property is read-only.
Connected Property (AS1Receiver Module)
This shows whether the module is connected.
Syntax
public var connected: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected; - (BOOL)connected; - (void)setConnected :(BOOL)newConnected;
Default Value
False
Remarks
This property is used to determine whether or not the class is connected to the remote host.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
EDIData Property (AS1Receiver Module)
The EDI data sent in Request .
Syntax
public var ediData: EDIData { get {...} }
@property (nonatomic,readonly,assign,getter=EDIData) NSString* EDIData; - (NSString*)EDIData; @property (nonatomic,readonly,assign,getter=EDIDataB) NSData* EDIDataB; - (NSData*)EDIDataB; @property (nonatomic,readonly,assign,getter=EDIType) NSString* EDIType; - (NSString*)EDIType; @property (nonatomic,readonly,assign,getter=EDIFilename) NSString* EDIFilename; - (NSString*)EDIFilename; @property (nonatomic,readonly,assign,getter=EDIName) NSString* EDIName; - (NSString*)EDIName;
Default Value
""
Remarks
The username for your incoming mail server. Set this before invoking Connect.
Firewall Property (AS1Receiver Module)
A set of properties related to firewall access.
Syntax
public var firewall: Firewall { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect; - (BOOL)firewallAutoDetect; - (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect; @property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType; - (int)firewallType; - (void)setFirewallType :(int)newFirewallType; @property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost; - (NSString*)firewallHost; - (void)setFirewallHost :(NSString*)newFirewallHost; @property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword; - (NSString*)firewallPassword; - (void)setFirewallPassword :(NSString*)newFirewallPassword; @property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort; - (int)firewallPort; - (void)setFirewallPort :(int)newFirewallPort; @property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser; - (NSString*)firewallUser; - (void)setFirewallUser :(NSString*)newFirewallUser;
Default Value
""
Remarks
The username for your incoming mail server. Set this before invoking Connect.
From Property (AS1Receiver Module)
The sender of the original message.
Syntax
public var from: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=from,setter=setFrom:) NSString* from; - (NSString*)from; - (void)setFrom :(NSString*)newFrom;
Default Value
""
Remarks
The sender of the original message. The recipient is given by SendTo.
Note that From and SendTo correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that From indicates the recipient, and SendTo indicates the sender of the MDN.
LocalHost Property (AS1Receiver Module)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public var localHost: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost; - (NSString*)localHost; - (void)setLocalHost :(NSString*)newLocalHost;
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
LogDirectory Property (AS1Receiver Module)
The path to a directory for logging.
Syntax
public var logDirectory: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=logDirectory,setter=setLogDirectory:) NSString* logDirectory; - (NSString*)logDirectory; - (void)setLogDirectory :(NSString*)newLogDirectory;
Default Value
""
Remarks
Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the original EDI data, the complete text of the outgoing request and the incoming response.
The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS1 messages created or downloaded by the class will be written with extension ".as1", and MDNs created or downloaded will be written with extension ".as1-mdn".
The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".
If logs cannot be written an exception will be thrown.
LogFile Property (AS1Receiver Module)
The log file written.
Syntax
public var logFile: String { get {...} }
@property (nonatomic,readonly,assign,getter=logFile) NSString* logFile; - (NSString*)logFile;
Default Value
""
Remarks
In case LogDirectory is specified two log files will be written in the specified directory and LogFile will contain the path.
LogFile will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename LogFile + ".log", and any EDI data read will be written with filename LogFile + ".dat". Raw AS1 messages and MDNs will also be written with extensions ".as1" and ".as1-mdn".
This property is read-only.
MailMessageCc Property (AS1Receiver Module)
The value of the Cc header of the mail message.
Syntax
public var mailMessageCc: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageCc) NSString* mailMessageCc; - (NSString*)mailMessageCc;
Default Value
""
Remarks
After calling SelectMailMessage this property will be populated with the value of the Cc header of the mail message.
This property is read-only.
MailMessageCount Property (AS1Receiver Module)
The number of messages waiting in the mailbox.
Syntax
public var mailMessageCount: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageCount) int mailMessageCount; - (int)mailMessageCount;
Default Value
0
Remarks
When the class is not connected to the mail server, the value of the MailMessageCount property is 0. When connected, it contains the number of messages in the mailbox. You may set MailMessageNumber to any value between 1 and MailMessageCount to inspect a given message.
This property is read-only.
MailMessageDate Property (AS1Receiver Module)
The message date for the currently selected message.
Syntax
public var mailMessageDate: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageDate) NSString* mailMessageDate; - (NSString*)mailMessageDate;
Default Value
""
Remarks
The date will be formatted like the following example:
Wed, 29 Dec 2004 11:58:02 +0700
This property is read-only.
MailMessageFrom Property (AS1Receiver Module)
The sender of the mail message.
Syntax
public var mailMessageFrom: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageFrom) NSString* mailMessageFrom; - (NSString*)mailMessageFrom;
Default Value
""
Remarks
After calling SelectMailMessage this property will be populated. When processing AS1 transmissions, this will correspond to From. When processing MDNs, this will correspond to SendTo.
This property is read-only.
MailMessageHeaders Property (AS1Receiver Module)
The message headers for the currently selected message.
Syntax
public var mailMessageHeaders: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageHeaders) NSString* mailMessageHeaders; - (NSString*)mailMessageHeaders;
Default Value
""
Remarks
After calling SelectMailMessage this property will contain the full headers of the mail message as reported by the mail server.
This property is read-only.
MailMessageNumber Property (AS1Receiver Module)
The message number on the incoming mail server.
Syntax
public var mailMessageNumber: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=mailMessageNumber,setter=setMailMessageNumber:) int mailMessageNumber; - (int)mailMessageNumber; - (void)setMailMessageNumber :(int)newMailMessageNumber;
Default Value
0
Remarks
MailMessageNumber specifies a number between 1 and MailMessageCount, and serves as a message pointer to an incoming mail message.
Set this property before calling SelectMailMessage
MailMessageReplyTo Property (AS1Receiver Module)
The value of the ReplyTo header of the mail message.
Syntax
public var mailMessageReplyTo: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageReplyTo) NSString* mailMessageReplyTo; - (NSString*)mailMessageReplyTo;
Default Value
""
Remarks
After calling SelectMailMessage this property will be populated with the value of the ReplyTo header of the mail message.
This property is read-only.
MailMessageSize Property (AS1Receiver Module)
The size of the mail message.
Syntax
public var mailMessageSize: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageSize) int mailMessageSize; - (int)mailMessageSize;
Default Value
0
Remarks
After calling QueryMessageSize this property will be populated with the the size of the mail message.
Note: It is recommended to use the QueryMessageSize method instead of getting this property.
This property is read-only.
MailMessageSubject Property (AS1Receiver Module)
The subject of the mail message.
Syntax
public var mailMessageSubject: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageSubject) NSString* mailMessageSubject; - (NSString*)mailMessageSubject;
Default Value
""
Remarks
After calling SelectMailMessage this property will be populated with the subject of the mail message.
This property is read-only.
MailMessageText Property (AS1Receiver Module)
The text of the mail message.
Syntax
public var mailMessageText: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageText) NSString* mailMessageText; - (NSString*)mailMessageText;
Default Value
""
Remarks
The text of the mail message identified by MailMessageNumber, if it has been downloaded from the server. To read the message, invoke ReadRequest (receiver) or ReadReceipt (sender). In case the message is not as AS1 message this will throw an exception, but you may catch it and then read the value of MailMessageText.
This property is read-only.
MailMessageTo Property (AS1Receiver Module)
The recipient of the mail message.
Syntax
public var mailMessageTo: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageTo) NSString* mailMessageTo; - (NSString*)mailMessageTo;
Default Value
""
Remarks
After calling SelectMailMessage this property will be populated with the recipient of the mail message.
This property is read-only.
MailMessageUID Property (AS1Receiver Module)
The unique id of the mail message.
Syntax
public var mailMessageUID: String { get {...} }
@property (nonatomic,readonly,assign,getter=mailMessageUID) NSString* mailMessageUID; - (NSString*)mailMessageUID;
Default Value
""
Remarks
After calling QueryMessageUID this property will be populated with the unique id of the mail message.
Note: It is recommended to use the QueryMessageUID method instead of getting this property.
This property is read-only.
MailServer Property (AS1Receiver Module)
The address of your mail server.
Syntax
public var mailServer: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=mailServer,setter=setMailServer:) NSString* mailServer; - (NSString*)mailServer; - (void)setMailServer :(NSString*)newMailServer;
Default Value
""
Remarks
The address of your mail server. By default, the class will send outgoing mail via SMTP, and receive incoming mail via POP. Moreover, the class will assume that both servers are located at the address specified by MailServer.
In case you use different addresses for incoming and outgoing mail you should set the POPServer and SMTPServer configuration settings appropriately. You may also set POPPort and SMTPPort in case you use nonstandard ports.
To configure SSL you should set SSLStartMode. Note that if SSL is used for sending but not receiving, or vice versa, you should set SSLStartMode each time you send or receive a file.
MDNReceipt Property (AS1Receiver Module)
The MDN-based receipt generated by the module.
Syntax
public var mdnReceipt: MDNReceipt { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=MDNReceiptContent,setter=setMDNReceiptContent:) NSString* MDNReceiptContent; - (NSString*)MDNReceiptContent; - (void)setMDNReceiptContent :(NSString*)newMDNReceiptContent; @property (nonatomic,readwrite,assign,getter=MDNReceiptContentB,setter=setMDNReceiptContentB:) NSData* MDNReceiptContentB; - (NSData*)MDNReceiptContentB; - (void)setMDNReceiptContentB :(NSData*)newMDNReceiptContent; @property (nonatomic,readonly,assign,getter=MDNReceiptHeaderCount) int MDNReceiptHeaderCount; - (int)MDNReceiptHeaderCount; @property (nonatomic,readonly,assign,getter=MDNReceiptHeaderField) NSString* MDNReceiptHeaderField; - (NSString*)MDNReceiptHeaderField; @property (nonatomic,readwrite,assign,getter=MDNReceiptHeaderIndex,setter=setMDNReceiptHeaderIndex:) int MDNReceiptHeaderIndex; - (int)MDNReceiptHeaderIndex; - (void)setMDNReceiptHeaderIndex :(int)newMDNReceiptHeaderIndex; @property (nonatomic,readwrite,assign,getter=MDNReceiptHeaders,setter=setMDNReceiptHeaders:) NSString* MDNReceiptHeaders; - (NSString*)MDNReceiptHeaders; - (void)setMDNReceiptHeaders :(NSString*)newMDNReceiptHeaders; @property (nonatomic,readonly,assign,getter=MDNReceiptHeaderValue) NSString* MDNReceiptHeaderValue; - (NSString*)MDNReceiptHeaderValue; @property (nonatomic,readonly,assign,getter=MDNReceiptMDN) NSString* MDNReceiptMDN; - (NSString*)MDNReceiptMDN; @property (nonatomic,readonly,assign,getter=MDNReceiptMessage) NSString* MDNReceiptMessage; - (NSString*)MDNReceiptMessage; @property (nonatomic,readonly,assign,getter=MDNReceiptMICValue) NSString* MDNReceiptMICValue; - (NSString*)MDNReceiptMICValue; @property (nonatomic,readonly,assign,getter=MDNReceiptSigningProtocol) NSString* MDNReceiptSigningProtocol; - (NSString*)MDNReceiptSigningProtocol;
Default Value
""
Remarks
The username for your incoming mail server. Set this before invoking Connect.
MDNTo Property (AS1Receiver Module)
The recipient for the Message Disposition Notification (MDN).
Syntax
public var mdnTo: String { get {...} }
@property (nonatomic,readonly,assign,getter=MDNTo) NSString* MDNTo; - (NSString*)MDNTo;
Default Value
""
Remarks
MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.
The receipt will be contained in MDNReceipt. If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, SendResponse will send the response as appropriate.
According to RFC specifications, MDNReceipt must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server.
This property is read-only.
MessageId Property (AS1Receiver Module)
The message ID of the incoming message.
Syntax
public var messageId: String { get {...} }
@property (nonatomic,readonly,assign,getter=messageId) NSString* messageId; - (NSString*)messageId;
Default Value
""
Remarks
MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.
This property is read-only.
Password Property (AS1Receiver Module)
The password for your incoming mail server.
Syntax
public var password: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password; - (NSString*)password; - (void)setPassword :(NSString*)newPassword;
Default Value
""
Remarks
The password for your incoming mail server. Set this before invoking Connect.
Request Property (AS1Receiver Module)
The AS1 request to be processed.
Syntax
public var request: String { get {...} set {...} }
public var requestB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=request,setter=setRequest:) NSString* request; - (NSString*)request; - (void)setRequest :(NSString*)newRequest; @property (nonatomic,readwrite,assign,getter=requestB,setter=setRequestB:) NSData* requestB; - (NSData*)requestB; - (void)setRequestB :(NSData*)newRequest;
Default Value
""
Remarks
You may specify the request manually, or you may load the request from the mail server by invoking ReadRequest.
The headers generally should be specified separately in RequestHeaders.
RequestHeaders Property (AS1Receiver Module)
The headers in the AS1 request.
Syntax
public var requestHeaders: Array<Header> { get {...} }
@property (nonatomic,readwrite,assign,getter=requestHeaderCount,setter=setRequestHeaderCount:) int requestHeaderCount; - (int)requestHeaderCount; - (void)setRequestHeaderCount :(int)newRequestHeaderCount; - (NSString*)requestHeaderField:(int)requestHeaderIndex; - (void)setRequestHeaderField:(int)requestHeaderIndex :(NSString*)newRequestHeaderField; - (NSString*)requestHeaderValue:(int)requestHeaderIndex; - (void)setRequestHeaderValue:(int)requestHeaderIndex :(NSString*)newRequestHeaderValue;
Default Value
""
Remarks
The username for your incoming mail server. Set this before invoking Connect.
RequestHeadersString Property (AS1Receiver Module)
The headers in the AS1 request.
Syntax
public var requestHeadersString: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=requestHeadersString,setter=setRequestHeadersString:) NSString* requestHeadersString; - (NSString*)requestHeadersString; - (void)setRequestHeadersString :(NSString*)newRequestHeadersString;
Default Value
""
Remarks
The headers will include any and all headers attached by the mail server(s).
ScanResult Property (AS1Receiver Module)
The result of invoking ParseRequest .
Syntax
public var scanResult: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=scanResult) int scanResult; - (int)scanResult;
Default Value
0
Remarks
ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.
0x01 | Unable to decrypt data. |
0x02 | Unable to decompress data. |
0x04 | Unable to validate integrity of data. |
0x08 | Unable to verify the signature. |
0x10 | Client requested unsupported signature type. |
0x20 | Client requested unsupported MIC algorithm. |
0x40 | Insufficient message security, as determined by the Config entries RequireSign and RequireEncrypt. |
0x80 | Unexpected processing error. An exception was encountered outside of message processing, such as configuration issues in the class. |
0x100 | Duplicate filename. |
0x200 | Illegal filename. |
0x400 | Empty filename. |
0x800 | Error writing incoming file. |
This property is read-only.
SendTo Property (AS1Receiver Module)
The recipient of the original message.
Syntax
public var sendTo: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=sendTo,setter=setSendTo:) NSString* sendTo; - (NSString*)sendTo; - (void)setSendTo :(NSString*)newSendTo;
Default Value
""
Remarks
The recipient of the original message. The originator is given by From.
Note that From and SendTo correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that From indicates the recipient, and SendTo indicates the sender of the MDN.
SignerCertEncoded Property (AS1Receiver Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var signerCertEncoded: String { get {...} set {...} }
public var signerCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertEncoded,setter=setSignerCertEncoded:) NSString* signerCertEncoded; - (NSString*)signerCertEncoded; - (void)setSignerCertEncoded :(NSString*)newSignerCertEncoded; @property (nonatomic,readwrite,assign,getter=signerCertEncodedB,setter=setSignerCertEncodedB:) NSData* signerCertEncodedB; - (NSData*)signerCertEncodedB; - (void)setSignerCertEncodedB :(NSData*)newSignerCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSignerCertEncodedB(signerCertEncoded: Data) throws public func setSignerCertEncoded(signerCertEncoded: String) throws
SignerCertStore Property (AS1Receiver Module)
This is the name of the certificate store for the client certificate.
Syntax
public var signerCertStore: String { get {...} set {...} }
public var signerCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertStore,setter=setSignerCertStore:) NSString* signerCertStore; - (NSString*)signerCertStore; - (void)setSignerCertStore :(NSString*)newSignerCertStore; @property (nonatomic,readwrite,assign,getter=signerCertStoreB,setter=setSignerCertStoreB:) NSData* signerCertStoreB; - (NSData*)signerCertStoreB; - (void)setSignerCertStoreB :(NSData*)newSignerCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
SignerCertStorePassword Property (AS1Receiver Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var signerCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertStorePassword,setter=setSignerCertStorePassword:) NSString* signerCertStorePassword; - (NSString*)signerCertStorePassword; - (void)setSignerCertStorePassword :(NSString*)newSignerCertStorePassword;
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SignerCertStoreType Property (AS1Receiver Module)
This is the type of certificate store for this certificate.
Syntax
public var signerCertStoreType: As1receiverSignerCertStoreTypes { get {...} set {...} }
public enum As1receiverSignerCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=signerCertStoreType,setter=setSignerCertStoreType:) int signerCertStoreType; - (int)signerCertStoreType; - (void)setSignerCertStoreType :(int)newSignerCertStoreType;
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
20 (cstSecurityKey) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SignerCertSubject Property (AS1Receiver Module)
This is the subject of the certificate used for client authentication.
Syntax
public var signerCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signerCertSubject,setter=setSignerCertSubject:) NSString* signerCertSubject; - (NSString*)signerCertSubject; - (void)setSignerCertSubject :(NSString*)newSignerCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSignerCertSubject(signerCertSubject: String) throws
SSLAcceptServerCertEncoded Property (AS1Receiver Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var sslAcceptServerCertEncoded: String { get {...} set {...} }
public var sslAcceptServerCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws
SSLCertEncoded Property (AS1Receiver Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var sslCertEncoded: String { get {...} set {...} }
public var sslCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLCertEncodedB(sslCertEncoded: Data) throws public func setSSLCertEncoded(sslCertEncoded: String) throws
SSLCertStore Property (AS1Receiver Module)
This is the name of the certificate store for the client certificate.
Syntax
public var sslCertStore: String { get {...} set {...} }
public var sslCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore :(NSString*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
SSLCertStorePassword Property (AS1Receiver Module)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
public var sslCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType Property (AS1Receiver Module)
This is the type of certificate store for this certificate.
Syntax
public var sslCertStoreType: As1receiverSSLCertStoreTypes { get {...} set {...} }
public enum As1receiverSSLCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType :(int)newSSLCertStoreType;
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
20 (cstSecurityKey) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SSLCertSubject Property (AS1Receiver Module)
This is the subject of the certificate used for client authentication.
Syntax
public var sslCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject :(NSString*)newSSLCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLCertSubject(sslCertSubject: String) throws
SSLProvider Property (AS1Receiver Module)
This specifies the SSL/TLS implementation to use.
Syntax
public var sslProvider: As1receiverSSLProviders { get {...} set {...} }
public enum As1receiverSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider :(int)newSSLProvider;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.
SSLServerCertEncoded Property (AS1Receiver Module)
This is the certificate (PEM/base64 encoded).
Syntax
public var sslServerCertEncoded: String { get {...} }
public var sslServerCertEncodedB: Data { get {...} }
@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded; @property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws
SSLStartMode Property (AS1Receiver Module)
Determines how the module starts the SSL negotiation. By default, SSL will not be used.
Syntax
public var sslStartMode: As1receiverSSLStartModes { get {...} set {...} }
public enum As1receiverSSLStartModes: Int32 { case sslAutomatic = 0 case sslImplicit = 1 case sslExplicit = 2 case sslNone = 3 }
@property (nonatomic,readwrite,assign,getter=SSLStartMode,setter=setSSLStartMode:) int SSLStartMode; - (int)SSLStartMode; - (void)setSSLStartMode :(int)newSSLStartMode;
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
0 (sslAutomatic - default) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone) | No SSL negotiation, no SSL security. All communication will be in plaintext mode. |
User Property (AS1Receiver Module)
The username for your incoming mail server.
Syntax
public var user: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user; - (NSString*)user; - (void)setUser :(NSString*)newUser;
Default Value
""
Remarks
The username for your incoming mail server. Set this before invoking Connect.
Config Method (AS1Receiver Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (AS1Receiver Module)
Connects to the incoming mail server.
Syntax
public func connect() throws -> Void
- (void)connect;
Remarks
Connects to the incoming mail server specified by MailServer. You must set User and Password prior to calling Connect. The connection will be maintained until you call Disconnect.
If you wish to connect in SSL you should first set the SSLStartMode property. Note that it is not necessary to explicitly connect to an SMTP server for outgoing mail; a connection will be created and destroyed each time a mail is sent.
CreateMDNReceipt Method (AS1Receiver Module)
Creates MDNReceipt .
Syntax
- (void)createMDNReceipt:(NSString*)headers :(NSString*)MDN :(NSString*)message;
Remarks
CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.
This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the class generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.
DeleteMessage Method (AS1Receiver Module)
Deletes the message specified by MailMessageNumber .
Syntax
public func deleteMessage() throws -> Void
- (void)deleteMessage;
Remarks
Requests that the MailServer delete the message specified by MailMessageNumber. The message will not actually be deleted until the connection is closed.
Disconnect Method (AS1Receiver Module)
Disconnects from the incoming mail server.
Syntax
public func disconnect() throws -> Void
- (void)disconnect;
Remarks
Disconnects from the incoming mail server specified by MailServer.
ParseRequest Method (AS1Receiver Module)
Parses the EDI message and determines the EDIData .
Syntax
public func parseRequest() throws -> Void
- (void)parseRequest;
Remarks
Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.
If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.
The class may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.
Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.
ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.
ProcessQueue Method (AS1Receiver Module)
Send the messages queued for sending.
Syntax
- (void)processQueue:(NSString*)directory;
Remarks
Invoking ProcessQueue sends the messages that have been queued by Queue.
ProcessRequest Method (AS1Receiver Module)
Processes the EDI data, and generates the receipt.
Syntax
public func processRequest() throws -> Void
- (void)processRequest;
Remarks
Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.
The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.
The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.
The class will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.
Queue Method (AS1Receiver Module)
Prepares and queues the message to the specified directory.
Syntax
Remarks
Invoking Queue will prepare and queue the AS1 message. It will be signed if SigningCert is set, encrypted if RecipientCert is set, and compressed if CompressionFormat is set. A receipt will be requested if MDNTo is set. The queued message can then be sent by invoking ProcessQueue.
ReadRequest Method (AS1Receiver Module)
Reads the AS1 request from the mail server.
Syntax
public func readRequest() throws -> Void
- (void)readRequest;
Remarks
In the Java edition, ReadRequest will retrieve the file specified by MailMessageNumber from the mail server. The request will be stored in Request and the headers in RequestHeaders. The headers will also be parsed as in ParseHeaders, and the appropriate values of From, SendTo, etc., will be populated. After looking up and setting your trading partner information (such as certificates) you may then call ProcessRequest.
Reset Method (AS1Receiver Module)
Resets the state of the control.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
Reset resets the state of the class. All properties will be set to their default values.
SelectMailMessage Method (AS1Receiver Module)
Selects and obtains information about the specified message.
Syntax
public func selectMailMessage() throws -> Void
- (void)selectMailMessage;
Remarks
This method selects the message specified by MailMessageNumber and retrieves information about it.
After calling this method properties such as MailMessageHeaders, MailMessageDate, MailMessageFrom, etc., allow you to determine if this message is an AS1 message. Additional properties are exposed via the Config method.
If this message is an AS1 transmission, you may use ReadRequest to read it. The Request and RequestHeaders properties will contain the request and request headers, and From will be populated with the originator of the request. You may then set trading partner information and invoke ProcessRequest to process the request.
SendResponse Method (AS1Receiver Module)
Sends the MDN receipt.
Syntax
public func sendResponse() throws -> Void
- (void)sendResponse;
Remarks
Sends the MDN receipt specified by MDNReceipt. You may create this receipt by invoking ProcessRequest or CreateMDNReceipt.
By default the class will assume that your SMTP server is located at the same address as your incoming mail server. To set a different address, to use a non default port, see the various Config settings. To use SMTPS (SSL), set the various SSL properties.
A response will only be sent if requested by the client. If MDNTo is empty, this method will do nothing.
ConnectionStatus Event (AS1Receiver Module)
This event is fired to indicate changes in the connection state.
Syntax
- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
EndTransfer Event (AS1Receiver Module)
Fired when the message text completes transferring.
Syntax
func onEndTransfer()
- (void)onEndTransfer;
Remarks
Fired when the message text completes transferring (on either a send or receive).
Error Event (AS1Receiver Module)
Information about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (AS1Receiver Module)
This event is fired for every message header being retrieved.
Syntax
Remarks
The Field parameter contains the name of the header (in the same case as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (AS1Receiver Module)
Fired with log information while processing a message.
Syntax
- (void)onLog:(NSString*)logType :(NSData*)logMessage;
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).
The LogMessage event parameter holds the raw log data.
The LogType event parameter indicates the type of log. Possible values are:
"LOG" | Information about the status of the process. |
"ERR" | An error was encountered. |
"DAT" | The EDI payload. |
"REQ" | The raw request |
"MDN" | The MDN response. |
"DEBUG" | Debug information. |
"DAT.INPUT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.ENCRYPT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.COMPRESS" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.SIGN" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DECRYPT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DECOMPRESS" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.VERIFY" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DEBUG" | Debug information when processing payload. Only applicable when LogDebug is True. |
PITrail Event (AS1Receiver Module)
Traces the commands sent to the mail server, and the respective replies.
Syntax
- (void)onPITrail:(int)direction :(NSString*)message;
Remarks
The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line, except for message header and body transfers.
The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:
0 (Client) | The Message originates from the client. |
1 (Server) | The Message originates from the server. |
2 (Info) | The Message is an informative message originating from the client software (the class code). |
SignerCertInfo Event (AS1Receiver Module)
This event is fired during verification of the signed message.
Syntax
func onSignerCertInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, certEncoded: Data)
- (void)onSignerCertInfo:(NSString*)issuer :(NSString*)serialNumber :(NSString*)subjectKeyIdentifier :(NSData*)certEncoded;
Remarks
During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:
Issuer specifies the subject of the issuer of the certificate used to sign the message.
SerialNumber is the serial number of the certificate used to sign the message.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.
Note: When this value is present, the class will automatically use this value to perform signature verification.
The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.
SSLServerAuthentication Event (AS1Receiver Module)
Fired after the server presents its certificate to the client.
Syntax
func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AS1Receiver Module)
Shows the progress of the secure connection.
Syntax
func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
StartTransfer Event (AS1Receiver Module)
Fired when the message text starts transferring (on either a send or receive).
Syntax
func onStartTransfer()
- (void)onStartTransfer;
Remarks
Fired when the message text starts transferring (on either a send or receive).
Transfer Event (AS1Receiver Module)
Fired while the message text gets transferred to or from MailServer .
Syntax
func onTransfer(bytesTransferred: Int64)
- (void)onTransfer:(long long)bytesTransferred;
Remarks
Fired while the message text gets transferred to or from MailServer.
EDIAttachment Type
This describes the file being attached.
Remarks
Information about the file's location that is being attached to the message is contained here.
Fields
contentType String |
The MIME content-type of this EDIAttachment. |
dataB Data |
This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment. |
data String |
This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment. |
filename String |
The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the . |
headers String |
The class fills out each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set. |
name String |
is the final name to be associated with the contents of either the or properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment. |
Constructors
public init()
public init(filename: )
public init(filename: , contentType: )
public init(filename: , contentType: , headers: )
EDIData Type
The EDI payload of the AS2 message.
Remarks
The EDI payload of the AS2 message.
Fields
dataB Data |
This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message. |
data String |
This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message. |
ediType String |
The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml". |
filename String |
In a sender, if is specified, the file specified will be used for the EDI payload of the transmission. will be populated with the name of the file. In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents. Note: When is set, the data will be written to the stream and this property will not be populated. |
name String |
is the final name to be associated with the contents of either the or properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload. When constructing EDI data to be sent, will be set to the same value as , but can be overridden after setting to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header. |
Constructors
public init()
public init(data: , eDIType: )
public init(filename: , eDIType: )
Firewall Type
This is the firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .
Fields
autoDetect Bool |
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
|
firewallType FirewallTypes |
This property determines the type of firewall to connect through. The applicable values are as follows: |
host String |
This property contains the name or IP address of firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class . |
password String |
This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class . |
port Int32 |
This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details. Note: This property is set automatically when is set to a valid value. See the description of the property for details. |
user String |
This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class . |
Constructors
public init()
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .
Fields
field String |
This property contains the name of the HTTP Header (this is the same case as it is delivered). |
value String |
This property contains the Header contents. |
Constructors
public init()
public init(field: , value: )
MDNReceipt Type
The complete MDN Receipt returned by the receiver.
Remarks
The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature.
Fields
contentB Data |
This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. |
content String |
This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. |
headerCount Int32 |
The number of headers in the MDN. |
headerField String |
|
headerIndex Int32 |
|
headers String |
Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option). You can also use , , , and to easily iterate through each individual header. |
headerValue String |
|
mdn String |
MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant. |
message String |
The human-readable portion of the MDN receipt. The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered. |
micValue String |
The Message Integrity Check(s) (one-way hash) of the original EDI message. An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed. The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5". |
signingProtocol String |
This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned. |
Constructors
public init()
public init(headers: , content: )
Config Settings (AS1Receiver Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.AS1Receiver Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filename: The filename of the EDI Data.This is a read only setting that gives the filename of the content received. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AS1 Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogFilename:
The base name of the log file.If set, this will be used as for the filename of the log file.
Note that only the base name should be specified as the component will append the appropriate file extension. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POPPort: The POP mail port to be used, if different than MailServer.The mail port to be used for POP (or POP/S). For implicit SSL, use port 995. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POPServer: The POP server to be used, if different than MailServer.The mail server to be used for POP (or POP/S), in case different than MailServer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SMTPAuthMechanism: The authentication mechanism used to connect to the SMTP server.By default, SMTPAuthMechanism is set to 0, which sends the AUTH command is SMTPUser and SMTPPassword are set. SMTPAuthMechanism can be set to 1 to use the more secure CRAM-MD5 authentication command. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SMTPPassword: The password used for authentication.If SMTPPassword is set to a non empty string, then when connecting to the SMTPServer an AUTH or CRAM-MD5 (depending on SMTPAuthMechanism) command is sent for user authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SMTPPort: The SMTP mail port to be used, if different than MailServer.The mail port to be used for SMTP (or POP/S). For implicit SSL, use port 465. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SMTPServer: The SMTP server to be used, if different than MailServer.The mail server to be used for SMTP (or SMTP/S), in case different than MailServer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SMTPSSLStartMode: Determines how SSL negotiation starts with the SMTP server.0 ssl Automatic 1 ssl Implicit 2 ssl Explicit 3 ssl None Default These modes have the same interpretation as defined by the property SSLStartMode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SMTPUser: The user name used for authentication.If SMTPUser is set to a non empty string, then when connecting to the SMTPServer an AUTH or CRAM-MD5 (depending on SMTPAuthMechanism) command is sent for user authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCADir:
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCAFile:
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCipherList:
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLPrngSeedData:
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCheckOCSP:
Whether to use OCSP to check the status of the server certificate.This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is by default, but can be set to to disable the extension.
This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
This functionality is currently not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class . The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to tells the class to use the internal implementation instead of using the system security libraries. This setting is set to by default on all platforms. |
Trappable Errors (AS1Receiver Module)
Note: The starred errors may be ignored by configuring the ErrorProcessingFlags and ErrorReportingFlags of the class.AS1Receiver Errors
701 Unable to write log file. | |
711 The incoming message was encrypted with an unknown protocol. | |
712 Unable to decrypt message. | |
713 Unable to decompress message. | |
732 *Unable to verify content integrity. | |
733 *Unsupported signature type was requested. | |
734 *Unsupported MIC algorithm(s) were requested. |
POP Errors
116 MailPort cannot be zero. Please specify a valid service port number. | |
118 Firewall error. Error message contains detailed description. | |
171 POP protocol error. Description contains the server reply. | |
172 Error communicating with server. Error text is attached. | |
173 Please specify a valid MailServer. | |
174 Busy executing current method. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |
SMTP Errors
118 Firewall Error. Error message contains detailed description. | |
161 SMTP protocol error. Description contains the server reply. | |
162 Error communicating with server. Error text is attached. | |
163 Please specify a MailServer. | |
164 Please specify a sender (From). | |
165 Please specify a recipient. | |
166 Busy executing current method. | |
301 Operation interrupted. | |
302 Can't open AttachedFile. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |
SMIME Errors
10191 Invalid index (RecipientIndex). | |
10192 Message decoding error (code). | |
10193 Unexpected message type. | |
10194 Unsupported hashing/signing algorithm. | |
10195 The message does not have any signers. | |
10196 The message signature could not be verified. | |
10197 Could not locate a suitable decryption certificate. | |
10198 The signer certificate could not be found. | |
10199 No signing certificate was supplied for signing the message. | |
10201 The specified certificate was not the one required. | |
10202 The specified certificate could not be found. | |
10221 Could not acquire CSP. | |
10222 Type validation error. | |
10223 Unsupported key size. | |
10224 Unrecognized Content-Type object identifier. | |
10225 Unrecognized public key format. | |
10226 No choices specified. | |
10228 Must specify output stream. | |
10280 Invalid part index. | |
10281 Unknown MIME type. | |
10283 No MIME-boundary found. | |
10280 Error decoding certificate. |