Part of lp.registry.interfaces.productjob View In Hierarchy
Known subclasses: lp.registry.interfaces.productjob.ICommercialExpiredJob, lp.registry.interfaces.productjob.ISevenDayCommercialExpirationJob, lp.registry.interfaces.productjob.IThirtyDayCommercialExpirationJob
Attribute | subject | The subject line of the notification. |
Attribute | email_template_name | The name of the email template to create the message body from. |
Attribute | reviewer | The user or agent sending the email. |
Attribute | recipients | An INotificationRecipientSet . |
Attribute | message_data | A dict that is interpolated with the email template. |
Attribute | reply_to | The optional address to set as the Reply-To. |
Method | getBodyAndHeaders | Return a tuple of email message body and headers. |
Method | sendEmailToMaintainer | Send an email to the product maintainer. |
Inherited from IProductJob:
Int | id | The tracking number of this job. |
Object | job | Undocumented |
Object | product | Undocumented |
Attribute | metadata | A dict of data for the job |
Inherited from IRunnableJob (via IProductJob):
Method | notifyOops | Notify interested parties that this job produced an OOPS. |
Method | getOopsVars | Return a list of variables to appear in the OOPS. |
Method | getOperationDescription | Describe the operation being performed, for use in oops emails. |
Attribute | user_error_types | A tuple of exception classes which result from user error. |
Attribute | retry_error_types | A tuple of exception classes which should cause a retry. |
Attribute | timeline_detail_filter | An optional (category, detail) -> detail callable to filter timeline action details. This may be used when some details are expected to be very large. |
Method | notifyUserError | Notify interested parties that this job encountered a user error. |
Method | run | Run this job. |
Method | celeryRunOnCommit | Request Celery to run this job on transaction commit. |
Inherited from IJob (via IProductJob, IRunnableJob):
Int | job_id | Undocumented |
Datetime | scheduled_start | Undocumented |
Datetime | date_created | Undocumented |
Datetime | date_started | Undocumented |
Datetime | date_finished | Undocumented |
Datetime | lease_expires | Undocumented |
Text | log | Undocumented |
Choice | status | The current state of the job. |
Int | attempt_count | Undocumented |
Int | max_retries | Undocumented |
Bool | is_pending | Undocumented |
Bool | is_runnable | Undocumented |
Attribute | base_json_data | A dict of data about the job. |
Choice | base_job_type | What type of job this is, only used for jobs that do not have their own tables. |
Method | acquireLease | Acquire the lease for this Job, or raise LeaseHeld. |
Method | getTimeout | Determine how long this job can run before timing out. |
Method | start | Mark the job as started. |
Method | complete | Mark the job as completed. |
Method | fail | Indicate that the job has failed permanently. |
Method | queue | Mark the job as queued for processing. |
Method | suspend | Mark the job as suspended. |
Method | resume | Mark the job as waiting. |
The body is constructed from the email template and message_data. The headers are a dict that includes the X-Launchpad-Rationale.
Parameters | email_template | A string that will be interpolated with message_data. |
address | The email address of the user the message is to. | |
Returns | ||
Unknown Field: reply_to | An optional email address to set as the Reply-To header. |