Facebook Methods description: notifications.sendEmail

anna_150.jpg

Send an email to the specified users, who must have added your application. You can only send one email to a user per day. Requires a session key for desktop apps, which may only send emails to the person whose session it is (does not require a session for web apps).

Parameters

 

string api_key The application key associated with the calling application.
string sig An MD5 hash of the current request and your secret key, as described in the authentication guide.
string v This must be set to 1.0 to use this version of the API.
string format Optional - desired response format. Either “XML” (default) or “JSON”.
string callback Optional - wrap the response inside a function call. This is primarily to enable cross-domain javascript requests using the <script> tag, sometimes known as “JSONP“. This works with both XML and JSON.
array recipients Comma-separated list of recipient ids. These must be people who have added the application. You can email up to 100 people at a time.
string subject Subject of the email.
string text Optional plain text version of the email.
string fbml Optional FBML version of the email.

You must include at least one of the fbml and text parameters. The fbml parameter is a stripped-down set of FBML which allows only tags that result in just text, links, and linebreaks.

Example Return XML

 

 

<?xml version="1.0" encoding="UTF-8"?>
<notifications_sendEmail_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd">211031,1160</notifications_sendEmail_response>

Response

Returns a comma-separated list of the recipients for whom the email was successfully sent.

Error codes

1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
101 The api key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.

Source page

Tags: ,

Related Post

No Comments

No comments yet.

Comments RSS TrackBack Identifier URI

Leave a comment