sharklaser

Overview ¶

Package sharklaser provides an interface to the Guerrilla Mail API. Client applications can use it to obtain temporary email addresses and receive emails. Its name is a reference to a domain name famously owned by Guerrilla Mail.

API specification can be found here: https://www.guerrillamail.com/GuerrillaMailAPI.html.

Sharklaser{} exports methods for each API function as well as higher-level wrapper methods (whose name begins with SL) for some. Direct API methods do almost no housekeeping and return rather bare representations of response data, whereas SL* methods simply return error values and try to do the sensible thing with the returned data (e.g. storing received email address in Sharklaser.Email and watching for expiration, saving emails to Sharklaser.Emails). It is needless to say which set client applications are encouraged to use.

Rather poor usage example:

Create new Sharklaser object:

shark := sharklaser.New()

Fill in any properties you don't like the default values for:

shark.UserAgent = "SuperFancyClient -=iCeCoLdMoD=-"
shark.UpdateInt = 120
shark.DomainName = "sharklasers.com"

Get a temporary address, check for email:

getaddr_err := shark.SLGetAddr() // Fills in shark.EmailAddr, notices address expiration
getmail_err := shark.SLUpdate() // Saves them to shark.Emails and updates next update time

Access Sharklaser.Emails:

fmt.Println(shark.Emails[0].Mail_subject)

Retrieve email body:

mail_body, fetch_err := shark.SLFetchEmail(0) // Fetches email body if unread, subsequently retrieves it from memory.

Be polite and let the server release the address when you're done:

shark.ForgetMe()

If WriteDebugLog is set to true and DebugLogFname contains a valid filename, API requests and responses will be logged to that file.

If DummyMode is set to true, no network requests will be sent. Instead, a file in directory DummyDir whose name matches the API function requested will be read. This is useful if you're developing a client application and do not wish to bother Guerrilla Mail with constant requests. However, parameters will be stripped and so only basic API interaction can be emulated this way.