| |
| |
| |
| |
| |
| |
| |
| |
The AIRMail WebService is used to access our AIRMail System. The
WebService resides behind the secure.eCotton.com webserver which uses 128-bit
encryption (https) for all requests and responses.
Methods which access sensitive data require authentication by the same User ID
and Password which are used to access the AIRMail System directly.
Below is a listing of each method available from the AIRMail WebService, along
with brief explanations:
Method SendMailFileText
Send a "mail" file to the AIRMail System using this method.
The content of the file (text only) should be passed as the MailFileText parameter,
complete with line delimiters.
The return value is True if the mail file was received successfully, or
False if there was a problem.
Method SendMailFileBinary
Send a non-text "mail" file to the AIRMail System using this method.
The content of the file, which can be binary or text, should be passed as the MailFileContent
parameter as an array of bytes (base64Binary format).
The return value is True if the mail file was received successfully, or
False if there was a problem.
Method GetWaitingMailList
Returns a comma-delimited list of filenames for mail files which are
waiting to be picked up for the requesting User ID. If no files are
waiting, an empty string is returned.
Normally, you would call GetWaitingMailList to get the list, then call
GetWaitingMail and SendGotWaitingMail for each file in the list.
Method GetWaitingMail
Returns the content of the mail file specified by the Filename
parameter. The return string is in plain text format, with linefeed
characters (ASCII value 10) only delimiting each line.
Normally, you would call GetWaitingMailList to get the list, then call
GetWaitingMail and SendGotWaitingMail for each file in the list.
Method SendGotWaitingMail
Acknowledges to the AIRMail System that you have received the mail
file specified by the Filename parameter. This method causes the
specified mail file to be moved out of your active "mailbox" and into
an archive area. Failure to call this method after receiving a
mail file using GetWaitingMail will result in the file being
left in your "mailbox" and therefore it will continue to appear on the next call
to GetWaitingMailList.
Normally, you would call GetWaitingMailList to get the list, then call
GetWaitingMail and SendGotWaitingMail for each file in the list.
Method GetNewsFlash
Returns the content of the next newsflash. The return string is in plain text format, with linefeed
characters (ASCII value 10) only delimiting each line.
If there are no new newsflashes, an empty string will be returned.
Method GetNewClassingUSDA
For gins that retrieve their classing data via AIRMail, this method allows the gin
to get any classing data which is waiting in their mailbox.
The return value is a string representing a classing data file, in the normal
USDA format, with line feed characters delimiting each line.
