(index ("efax-account" 0) ("efax-username" 229) ("efax-password" 390) ("efax-send" 541) ("efax-status" 2716))
(def (sig (parameter "(efax-account  [ACCOUNT])" (id efax-account))) (p (tt "ACCOUNT") " should be a string which identifies your eFax developer account number.  This is generally your fax number (digits only, no spaces etc)."))
(def (sig (parameter "(efax-username [USERNAME])" (id efax-username))) (p (tt "USERNAME") " should be a string which identifies your eFax developer username."))
(def (sig (parameter "(efax-password [PASSWORD])" (id efax-password))) (p (tt "PASSWORD") " should be a string which identifies your eFax password."))
(def (sig (procedure "(efax-send RECIPIENTS FILES [account: ACCOUNT] [username: USERNAME] [password: PASSWORD] [transmission-id: TID] [unique-id: UNIQUE?] [customer-id: CID] [self-busy: SELFBUSY?] [high-resolution: HIRES?] [high-priority: PRIO?])" (id efax-send))) (p "Send " (tt "FILES") " (a list of pairs) as a fax message to " (tt "RECIPIENTS") ", which is either a string, a list of strings or a list of alists identifying the recipients.  If it's a string or list of strings, these are assumed to be the fax numbers for these recipients. If " (tt "RECIPIENTS") " is an alist, it can contain the following keys: " (tt "name") ", " (tt "company") " and " (tt "fax") ".  " (tt "fax") " is a string containing the fax number of this recipient (must be supplied), " (tt "company") " is a string that holds the company name (optional) and " (tt "name") " is a string that holds the recipient name (optional).  These keys can be used in the fax header line.") (p (tt "FILES") " should be a list of pairs, the car being a symbol or string identifying the type of the file and the cdr being a string with the file's contents.  The allowed values for the type are: pdf, txt, doc(x), xls(x), ppt(x), htm(l), png, smp, gif, tif(f), jp(e)g, or rtf.") (p "If " (tt "TID") " is given, this can later be used as a key to retrieve the status using " (tt "efax-status") ".  If " (tt "UNIQUE?") " is " (tt "#t") ", this key must be unique or an error is raised.  Both default to " (tt "#f") ".") (p (tt "CID") " is purely informational and will be returned in subsequent " (tt "efax-status") " calls.  Can be useful for accounting or debugging purposes.  Defaults to " (tt "#f") ".") (p "If " (tt "HIRES?") " is " (tt "#t") ", the fax will be in high resolution and if " (tt "PRIO?") " is " (tt "#t") ", the fax will be given extra priority.  Both these options cost extra!  Both default to " (tt "#f") ".") (p "The result of this call is an alist with two keys:") (dl (dt (tt "doc-id")) (dd "The document ID of this transmission assigned by eFax.") (dt (tt "transmission-id")) (dd "The transmission ID which you supplied as " (tt "TID") ", or " (tt "#f") " if you didn't supply one.")))
(def (sig (procedure "(efax-status [account: ACCOUNT] [username: USERNAME] [password: PASSWORD] [doc-id: DID] [transmission-id: TID])" (id efax-status))) (p "Fetch the status of a message previously sent with " (tt "efax-send") " (or other means).  You can either pass " (tt "DID") ", which should be the eFax document id (" (tt "document-id") " in the alist returned by " (tt "efax-send") ") or your own transmission identifier (" (tt "transmission-id") " in the alist returned by " (tt "efax-send") ", which is the " (tt "TID") " you passed in yourself).") (p "This will return an alist which currently has two keys: " (tt "transmission-id") " and " (tt "recipients") ". " (tt "transmission-id") " is simply the transmission ID of the message, or " (tt "#f") " if you didn't provide one when sending it.  " (tt "recipients") " is a list of pairs, the cars of which are fax numbers (strings) and the cdrs of which are alists with the following keys (all values are strings):") (dl (dt (tt "name") " (optional)") (dd "The name of the recipient as specified in " (tt "efax-send") ".") (dt (tt "company") " (optional)") (dd "The company of the recipient as specified in " (tt "efax-send") ".") (dt (tt "fax")) (dd "The fax number again") (dt (tt "status-message")) (dd "A human-readable message indicating the message's current status.") (dt (tt "status-classification") " (optional)") (dd "A value indicating the message's status \"classification\".") (dt (tt "status-outcome") " (optional)") (dd "Another value like " (tt "status-classification") ". The difference is unclear from the documentation. In success cases both " (tt "status-classification") " and " (tt "status-outcome") " have \"Success\" as a value.") (dt (tt "last-attempt-date") " (optional)") (dd "The date of the last transmission attempt.") (dt (tt "last-attempt-time") " (optional)") (dd "The time of the last transmission attempt.") (dt (tt "next-attempt-date") " (optional)") (dd "The date when the next transmission attempt will take place, if the message hasn't been successfully transmitted and eFax hasn't given up yet.") (dt (tt "next-attempt-time") " (optional)") (dd "The time when the next transmission attempt will take place.") (dt (tt "pages-scheduled") " (optional)") (dd "The number of pages that were scheduled for transmission.") (dt (tt "pages-sent") " (optional)") (dd "The number of pages that were actually sent.") (dt (tt "baud-rate") " (optional)") (dd "The baud rate used for the transmission.") (dt (tt "duration") " (optional)") (dd "Duration in minutes for the transmission.") (dt (tt "retries") " (optional)") (dd "Number of retries for the transmission.") (dt (tt "remote-csid") " (optional)") (dd "The CSID transmitted to.")))
