Importing Carriers from a Text File

Top  Previous  Next

To import a Comma Separated Values text file in to NotePager Pro to add or update Carriers, the file must be formatted very, very specifically.

 

The specific data structure of each record is as follows:

 

"Version","Name","PhoneNumber","ModemSettings","MaxChars","InitString","MessageLimit","DialType","AuthType","AuthUser","AuthPassword","RelayMail","RelayServer","Priority"

 

Field

Description and Values

Version

This field declares the version of the import file and should be set to: 500

Name

This field assigns the name of the carrier to be imported. Names should be assigned with alphanumeric characters. Special characters such as ! @ # $ % ^ & * ( ) + = [ ] { } / ? \ | ; : ' " , < > and spaces are disallowed from this field.

PhoneNumber

This field value means different things for different protocols.

 

If this carrier is configured to use a dialing protocol (TAP, TONE or UCP), this field declares the phone number to dial.

 

If this carrier is configured to use the SMTP protocol, this field declares the Sending Domain and MUST match the email domain of the network on which the PC is a member.

ModemSettings

This field value means different things for different protocols.

 

If this carrier is configured to use a dialing protocol (TAP, TONE or UCP), this field declares communication parameters to use and should be set to: BaudRate,Parity,DataBits,StopBits. For example: 1200,e,7,1

 

If this carrier is configured to use the SMTP protocol, this field declares the port to use.

MaxChars

This field assigns the maximum number of characters that can be sent in a single message. For an SMS carrier, this value should be set to 160. For a paging carrier, this value should be set to 240.

InitString

If this carrier is configured to use a dialing protocol (TAP, TONE or UCP), this field declares initialization string for your modem. If you are unsure what initialization string to use, including parenthesis, enter the value: (auto)

 

If this carrier is NOT configured to use a dialing protocol, leave this field as a blank string value ("").

MessageLimit

This field declares whether or not this carrier has a maximum number of messages it can receive before the connection is closed and further messages are sent on successive connections. If this carrier does not have a message limit, enter the value: 0

DialType

This field declares the protocol to use.

Protocol

Required Value

FAX

fax

FAXSRV

fxs

GSMAT

gsm

SMTP

eml

SNPP

snp

TAP

tap

TONE

tone-,,@

UCP

ucp

WCTP

wct-0

AuthType

If required by a carrier, this field declares the authentication type.

Value

Authentication Type

0

No Authentication

1

Standard.

 

In SMTP, the authentication used is based on what type the SMTP server reports that it supports after the EHLO command is sent. Order of preference if more than one form is supported by the server: CRAM-MD5, PLAIN, LOGIN.

 

In SNPP, the LOGI command used.

 

In WCTP, the senderID (AuthUser field is used) and securityCode (AuthPassword field is used) data fields are used/sent.

 

In TAP, the password (AuthPassword field is used) is sent as part of the PG1 response.

 

In UCP, the password (AuthPassword field is used) is included in the data sent.

2

Sender Override

 

In SMTP, the AuthUser field value is used in the Mail From field in the SMTP envelope.

 

In WCTP, the AuthUser field value is used in the senderID data field that is sent.

3

CRAM-MD5

 

In SMTP, the CRAM-MD5 type authentication is used, even if the server doesn't advertise that it is supported.

4

PLAIN

 

In SMTP, the PLAIN type authentication is used, even if the server doesn't advertise that it is supported.

5

LOGIN

In SMTP the LOGIN type authentication is used, even if the server doesn't advertise that it is supported.

6

NTLM

 

In SMTP, the NTLM type authentication is used, even if the server doesn't advertise that it is supported.

11

WCTP-MISCINFO

 

In WCTP, the senderID (AuthUser field is used) and miscInfo (AuthPassword field is used) data fields are used/sent.

12

WCTP-RECIPIENT

 

In WCTP, the Sender's email address is used for the senderID field

AuthUser

If this carrier will be using authentication and the authentication method requires a username, enter it in this field.

AuthPassword

If this carrier will be using authentication and the authentication method requires a password, enter it in this field.

RelayMail

If this carrier is configured to use the SMTP protocol, this field value determines whether this carrier uses the direct send method of delivery or needs to relay through an SMTP server. This field value should be set to #FALSE# if direct send it being used and should be set to #TRUE# if this carrier should relay.

 

If this carrier is NOT configured to use SMTP, leave this field as a blank string value ("").

Relayserver

If this carrier is configured to use the SMTP protocol and needs to relay through an SMTP server, this field value declares the SMTP server to use.

 

If this carrier is NOT configured to use SMTP, leave this field as a blank string value ("").

Priority

This field value must be set to a value from 1 to 100, with 1 representing the highest priority. The default value all carriers and recipients is 100, however, numbers larger than 100 can be used. The default value is 100.

 

This is an example of an import record that would import a carrier named 'ATT' that's set to use the TAP protocol to dial the AT&T TAP terminal 18009094602 with a baud rate of 1200, parity of even, data bits of 7, stop bits of 1, automatic initialization string and authentication is not required:

"500","ATT","18009094602","1200,e,7,1","160","(auto)","0","tap","0","","",#FALSE#,"","100"

 

This is an example of an import record that would import a carrier named 'Email' that's set to use the SMTP protocol over port 25 with a declared sending domain where relaying is enabled, authentication is required and a username and password are declared:

"500","Email","sendingdomain.com","25","160","","0","eml","1","username","password",#TRUE#,"relayserveraddresshere","100"