l.r.b.p.EmailToPersonView(LaunchpadFormView) : class documentation

Part of lp.registry.browser.person View In Hierarchy

The 'Contact this user' page.
Method initialize See ILaunchpadFormView.
Method setUpFields Set up fields for this view.
Method recipients The recipients of the email message.
Method action_send Send an email to the user.
Method cancel_url The return URL.
Method contact_is_allowed Whether the sender is allowed to send this email or not.
Method has_valid_email_address Whether there is a contact address.
Method contact_is_possible Whether there is a contact address and the user can send email.
Method next_try When can the user try again?
Method contact_not_possible_reason The reason the person cannot be contacted.
Method page_title Return the appropriate pagetitle.

Inherited from LaunchpadFormView:

Method __init__ Undocumented
Method render Return the body of the response.
Method extendFields Allow subclasses to extend the form fields.
Method setUpWidgets Set up the widgets using the view's form fields and the context.
Method help_links Dictionary mapping field names to help links.
Method adapters Provide custom adapters for use when setting up the widgets.
Method action_url Set the default action URL for the form.
Method has_available_actions Does the view have any available actions that will render?
Method initial_values Override this in your subclass if you want any widgets to have
Method addError Add a form wide error.
Method getFieldError Get the error associated with a particular field.
Method setFieldError Set the error associated with a particular field.
Static Method validate_none Do not do any validation.
Method validate_widgets Validate the named form widgets.
Method error_count Undocumented
Method ajax_failure_handler Called by the form if validate() finds any errors.
Method validate Validate the form.
Method validate_cancel Noop validation in case we cancel.
Method focusedElementScript Helper function to construct the script element content.
Method isSingleLineLayout Undocumented
Method isMultiLineLayout Undocumented
Method isCheckBoxLayout Undocumented
Method showOptionalMarker Should the (Optional) marker be shown?
Method _processNotifications Add any notification messages to the response headers.
Method _abort Abort the form edit.
Method _validate Check all widgets and perform any custom validation.
def initialize(self):
See ILaunchpadFormView.
def setUpFields(self):
Set up fields for this view.

The field needing special set up is the 'From' fields, which contains a vocabulary of the user's preferred (first) and validated (subsequent) email addresses.

@cachedproperty
def recipients(self):
The recipients of the email message.
Returnsthe recipients of the message. (type: ContactViaWebNotificationRecipientSet.)
@action(_('Send'), 'send')
def action_send(self, action, data):
Send an email to the user.
@property
def cancel_url(self):
The return URL.
@property
def contact_is_allowed(self):
Whether the sender is allowed to send this email or not.
@property
def has_valid_email_address(self):
Whether there is a contact address.
@property
def contact_is_possible(self):
Whether there is a contact address and the user can send email.
@property
def next_try(self):
When can the user try again?
@property
def contact_not_possible_reason(self):
The reason the person cannot be contacted.
@property
def page_title(self):
Return the appropriate pagetitle.
API Documentation for Launchpad, generated by pydoctor at 2019-07-21 00:00:04.